FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-45583: Correct datamodel.rst documentation of int() by Arthur-Milchior · Pull Request #29182 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Merged
ambv merged 1 commit into
python:mainfrom
Arthur-Milchior:main
Oct 28, 2021
ConversationCommits (1)ChecksFiles changed
Merged

bpo-45583: Correct datamodel.rst documentation of int()#29182
ambv merged 1 commit into
python:mainfrom
Arthur-Milchior:main

Conversation

Arthur-Milchior commented Oct 23, 2021 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

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 commented Oct 23, 2021

Copy link
Copy Markdown

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 added the docs Documentation in the Doc dir label Oct 23, 2021

Arthur-Milchior commented Oct 23, 2021

Copy link
Copy Markdown
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)

serhiy-storchaka reviewed Oct 23, 2021
View reviewed changes
Comment thread Doc/reference/datamodel.rst Outdated

Arthur-Milchior commented Oct 23, 2021

Copy link
Copy Markdown
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 changed the title Correct datamodel.rst documentation of int() bpo-45583: Correct datamodel.rst documentation of int() Oct 23, 2021
mdickinson approved these changes Oct 24, 2021
View reviewed changes

mdickinson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 commented Oct 24, 2021

Copy link
Copy Markdown
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. :-)

bpo-45583: Correct datamodel documentation of int()
eff1a2b 
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 commented Oct 24, 2021

Copy link
Copy Markdown
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?

ambv merged commit d9c1868 into python:main Oct 28, 2021

miss-islington commented Oct 28, 2021

Copy link
Copy Markdown
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
bpo-45583: Correct datamodel documentation of int() (pythonGH-29182)
04a8240 
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 <arthur@milchior.fr>

bedevere-bot commented Oct 28, 2021

Copy link
Copy Markdown

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
bpo-45583: Correct datamodel documentation of int() (pythonGH-29182)
13ee17b 
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 <arthur@milchior.fr>

bedevere-bot commented Oct 28, 2021

Copy link
Copy Markdown

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

bedevere-bot commented Oct 28, 2021

Copy link
Copy Markdown

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
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29287
76658e5 
)

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 <arthur@milchior.fr>
ambv pushed a commit that referenced this pull request Oct 28, 2021
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29285
fef54ab 
)

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 <arthur@milchior.fr>
ambv pushed a commit that referenced this pull request Oct 28, 2021
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29286
3767e0d 
)

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 <arthur@milchior.fr>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

serhiy-storchaka serhiy-storchaka approved these changes
+1 more reviewer
mdickinson mdickinson approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL