Skip to content

bpo-45583: Correct datamodel.rst documentation of int() #29182

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 1 commit into from
Oct 28, 2021

Conversation

Arthur-Milchior
Copy link
Contributor

@Arthur-Milchior Arthur-Milchior commented Oct 23, 2021

bpo-45583: Correct datamodel.rst documentation of int()

It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8

https://bugs.python.org/issue45583

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@Arthur-Milchior

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Oct 23, 2021
@Arthur-Milchior
Copy link
Contributor Author

I confirm I just signed the CLA.
Since the CLA ask for the bugs.python.org username I just created the account ArthurMilchior and indicated that my github name is Arthur-Milchior.
So normally https://check-python-cla.herokuapp.com/ should be able to confirm I signed it (even if it's surprising it asks for github username which was not provided in the CLA in the first place)

@Arthur-Milchior
Copy link
Contributor Author

I think it would also need to be backported to 3.8, since it was when the change was introduced. I see only 3.9 and 3.10 labels added

@serhiy-storchaka serhiy-storchaka changed the title Correct datamodel.rst documentation of int() bpo-45583: Correct datamodel.rst documentation of int() Oct 23, 2021
Copy link
Member

@mdickinson mdickinson left a comment

Choose a reason for hiding this comment

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

This is fine - it's a net improvement on what's already there. But at a nitpick level, it still reads as somewhat ambiguous to me: in the qualifier

if :meth:__int__ and :meth:__index__ are not defined

it's not immediately clear whether it refers to the situation where neither of these is defined, or to the situation where they're not both defined. You could possibly tighten it up as:

if neither :meth:__int__ nor :meth:__index__ is defined

Approving, since this is good to go as-is - the above is just a suggestion.

@mdickinson
Copy link
Member

@Arthur-Milchior

I think it would also need to be backported to 3.8

3.8 is in security-fix-only mode at this point, so we wouldn't normally backport docfixes to 3.8.

should I still be listed as the commit author while you are the one who wrote the actual sentence

Unless @serhiy-storchaka objects, I think that's fine. @serhiy-storchaka has one or two other commits to his name. :-)

It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8
@Arthur-Milchior
Copy link
Contributor Author

Thanks for the explanation. I admit that I'm just a Python user and didn't check the rules for what is ported or not to previous version.
Do you have any idea how much time I should wait after signing the CLA for it to be shown as signed?

@miss-islington
Copy link
Contributor

Thanks @Arthur-Milchior for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 28, 2021
It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868)

Co-authored-by: Arthur Milchior <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 28, 2021
@bedevere-bot
Copy link

GH-29285 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 28, 2021
It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868)

Co-authored-by: Arthur Milchior <[email protected]>
@bedevere-bot
Copy link

GH-29286 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Oct 28, 2021
@bedevere-bot
Copy link

GH-29287 is a backport of this pull request to the 3.8 branch.

ambv pushed a commit that referenced this pull request Oct 28, 2021
)

It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868)

Co-authored-by: Arthur Milchior <[email protected]>
ambv pushed a commit that referenced this pull request Oct 28, 2021
)

It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868)

Co-authored-by: Arthur Milchior <[email protected]>
ambv pushed a commit that referenced this pull request Oct 28, 2021
)

It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868)

Co-authored-by: Arthur Milchior <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants