-
-
Notifications
You must be signed in to change notification settings - Fork 510
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
Trac #34920: Fix description of inputs of primes. #35215
Conversation
- ``start`` - an integer (default: 2) optional argument - | ||
giving lower bound for the primes | ||
|
||
- ``stop`` - an integer (or infinity) optional argument - | ||
giving upper (open) bound for the primes | ||
- ``stop`` - an integer (or infinity) - giving upper (open) bound for the | ||
primes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point mathematically. On the other hand, stop
is actually an optional argument in the code sense. Should you change the argument to the function rather than changing the docs?
Then see this SO post for keeping the user interface the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I change the signature to primes(start=2, stop=None, proof=None)
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thats what I was thinking.
Now let's wait for the tests to run and pass. |
Documentation preview for this PR is ready! 🎉 |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## develop #35215 +/- ##
===========================================
+ Coverage 88.57% 88.58% +0.01%
===========================================
Files 2140 2140
Lines 397273 397273
===========================================
+ Hits 351891 351935 +44
+ Misses 45382 45338 -44
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
LGTM. |
Fix docstring of the
primes
function.📚 Description
The documentation of
primes
states that "stop" is optional and "start" is required, when in fact it is the opposite.Closes #34920
📝 Checklist
⌛ Dependencies