Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented doctests for geometry-related classes #12368

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

IsxImattI
Copy link

Describe your change: Contributes to #9943 - I have added doctests to multiple classes for geometric shapes. The doctests include tests for proper initialization, exception handling, and class methods.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • [x ] Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • [x ] I have read CONTRIBUTING.md.
  • [x ] This pull request is all my own work -- I have not plagiarized.
  • [x ] I know that pull requests will not be merged if they fail the automated tests.
  • [x ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [x ] All new Python files are placed inside an existing directory.
  • [x ] All filenames are in all lowercase characters with no spaces or dashes.
  • [x ] All functions and variable names follow Python naming conventions.
  • [ x] All function parameters and return values are annotated with Python type hints.
  • [ x] All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • [ x] If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Nov 10, 2024
@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Nov 10, 2024
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant