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
bpo-29749: Outdated int docstring #565
Conversation
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA. This is necessary for legal reasons before we can look at your contribution. Please follow these steps to help rectify the issue:
Thanks again to your contribution and we look forward to looking at it! |
@svelankar, thanks for your PR! By analyzing the history of the files in this pull request, we identified @mdickinson, @serhiy-storchaka, @tim-one, @brettcannon and @benjaminp to be potential reviewers. |
The docstring is actually correct:
So closing this. |
The docstring has the x parameter as a keyword which is no longer correct, and that is what the PR is fixing. |
@bitdancer but it also dropped the default arg, so shouldn't it be |
"or return 0 if no arguments are given" - This is from the docstring. Wouldn't this suffice to indicate that the positional argument is optional ? |
@svelankar no because if you are quickly glancing at the docstring just for the signature to e.g. remember argument orders and such then you won't bother reading the whole docstring. |
Ok. Please let me know if int([x]) is the only change you would like to see. |
Nope, I think that minor change is all that's necessary. |
Oh, and please sign the CLA. |
Done. |
Thanks for all the work on this, @svelankar ! |
Thanks for the opportunity. Hope to make many more non trivial contributions in the future. Its nice to be part of this community. |
* Fix status check comment for timed out or failed checks * Fix coverage issue * Remove unrelated change * Last unrelated change * Update tests/test_status_change.py Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
int docstring is the only one that needs to be changed. docstrings for float,tuple and list look fine to me.
Please review.