fix: correct docstrings in prime_numbers.py (list -> generator, grammar fix)#14300
Open
23f2000188 wants to merge 2 commits intoTheAlgorithms:masterfrom
Open
fix: correct docstrings in prime_numbers.py (list -> generator, grammar fix)#1430023f2000188 wants to merge 2 commits intoTheAlgorithms:masterfrom
23f2000188 wants to merge 2 commits intoTheAlgorithms:masterfrom
Conversation
The docstrings for slow_primes(), primes(), and fast_primes() incorrectly stated 'Return a list of all primes numbers up to max.' However, all three functions return a Generator[int], not a list. Also fixed the grammar: 'primes numbers' -> 'prime numbers'.
The docstrings for slow_primes(), primes(), and fast_primes() incorrectly stated 'Return a list of all primes numbers up to max.' However, all three functions return a Generator[int], not a list. Also fixed the grammar: 'primes numbers' -> 'prime numbers'.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The docstrings for
slow_primes(),primes(), andfast_primes()inmaths/prime_numbers.pyincorrectly stated:There are two issues:
-> Generator[int]andyieldvalues — they return a generator, not a list.Fix
Changed all three occurrences from:
to:
Checklist
Generator[int]