bpo-29749: Outdated int docstring by soolabettu · Pull Request #565 · python/cpython · GitHub
Skip to content

bpo-29749: Outdated int docstring - #565

Merged
brettcannon merged 2 commits into
python:masterfrom
soolabettu:master
Mar 9, 2017
Merged

brettcannon merged 2 commits into
python:masterfrom
soolabettu:master

Conversation

@soolabettu

Copy link
Copy Markdown
Contributor

int docstring is the only one that needs to be changed. docstrings for float,tuple and list look fine to me.
Please review.

@the-knights-who-say-ni

Copy link
Copy Markdown

@mention-bot

Copy link
Copy Markdown

@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.

@soolabettu soolabettu closed this Mar 8, 2017
@soolabettu soolabettu reopened this Mar 8, 2017
@brettcannon

Copy link
Copy Markdown
Member

The docstring is actually correct:

>>> int()
0

So closing this.

@brettcannon brettcannon closed this Mar 8, 2017
@bitdancer

Copy link
Copy Markdown
Member

The docstring has the x parameter as a keyword which is no longer correct, and that is what the PR is fixing.

@bitdancer bitdancer reopened this Mar 8, 2017
@brettcannon

Copy link
Copy Markdown
Member

@bitdancer but it also dropped the default arg, so shouldn't it be int([x]) to show that the x argument is positional-only while being optional?

@soolabettu soolabettu changed the title bpo-29749: Outdated int() docstring bpo-29749: Outdated int docstring Mar 8, 2017
@soolabettu

Copy link
Copy Markdown
Contributor Author

"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 ?

@brettcannon

Copy link
Copy Markdown
Member

@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.

@soolabettu

Copy link
Copy Markdown
Contributor Author

Ok. Please let me know if int([x]) is the only change you would like to see.

@brettcannon

Copy link
Copy Markdown
Member

Nope, I think that minor change is all that's necessary.

@brettcannon

Copy link
Copy Markdown
Member

Oh, and please sign the CLA.

@soolabettu

Copy link
Copy Markdown
Contributor Author

Done.

@brettcannon
brettcannon merged commit 390a096 into python:master Mar 9, 2017
@brettcannon

Copy link
Copy Markdown
Member

Thanks for all the work on this, @svelankar !

@soolabettu

Copy link
Copy Markdown
Contributor Author

jaraco pushed a commit that referenced this pull request Dec 2, 2022
* 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>
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.

5 participants