Skip to content

Added type hints and doctest for maths/prime_check. #2367

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

Merged
merged 2 commits into from
Aug 29, 2020
Merged

Added type hints and doctest for maths/prime_check. #2367

merged 2 commits into from
Aug 29, 2020

Conversation

frangiz
Copy link
Contributor

@frangiz frangiz commented Aug 29, 2020

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@frangiz
Copy link
Contributor Author

frangiz commented Aug 29, 2020

Should I remove all the unittests and move some of them to the doctest instead?

@cclauss
Copy link
Member

cclauss commented Aug 29, 2020

There are two main kinds of tests built into Python:

Given that this file already has strong unittest coverage, it does not also need doctests. The typehint is useful however.

@frangiz
Copy link
Contributor Author

frangiz commented Aug 29, 2020

@cclauss , I have updated the PR according to your comment. Let's say I fix a bunch of type hints, still want one file per PR (as mentioned in contributing.md) or is a few together OK for things like this?

Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!! Thanks.

@cclauss cclauss merged commit ab5a046 into TheAlgorithms:master Aug 29, 2020
@cclauss
Copy link
Member

cclauss commented Aug 29, 2020

One file per commit please (my brain power is limited). ;-)

@frangiz frangiz deleted the type-hints_prime_check branch August 29, 2020 15:45
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* Added type hints and doctest for maths/prime_check.

* Removed doctests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants