Skip to content

PyLong_AsLongLong() docs should refer to 'long long' rather than 'long' #18082

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 21, 2020
Merged

PyLong_AsLongLong() docs should refer to 'long long' rather than 'long' #18082

merged 1 commit into from
Jan 21, 2020

Conversation

keitherskine
Copy link
Contributor

In the docs for PyLong_AsLongLong(), it states that an Overflow exception will be raised if the value is out of range for a C-style long integer type. I believe this should refer to long long, to align with the rest of the description of this function.

The docs for the other functions in Doc/c-api/long.rst appear to be correct.

This seems like a trivial docs change, but if I need to raise a bug issue for it, do let me know.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jan 20, 2020
aeros
aeros approved these changes Jan 20, 2020
View reviewed changes
Copy link
Contributor

@aeros aeros left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR @keitherskine and welcome!

This seems like a trivial docs change, but if I need to raise a bug issue for it, do let me know.

This PR is simple enough that we can skip the issue and news entry, that's typically the standard procedure for minor documentation fixes.

The fix looks correct to me. I'll request a review @mdickinson though to be certain, since it looks like he made the last change to this section in f0acfee.

@aeros aeros requested a review from mdickinson January 20, 2020 22:12
@keitherskine
Copy link
Contributor Author

Many thanks @aeros , sounds good!

mdickinson
mdickinson approved these changes Jan 21, 2020
View reviewed changes
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.

LGTM

@mdickinson mdickinson merged commit 47be7d0 into python:master Jan 21, 2020
@bedevere-bot
Copy link

@mdickinson: Please replace # with GH- in the commit message next time. Thanks!

@miss-islington
Copy link
Contributor

Thanks @keitherskine for the PR, and @mdickinson for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

I'm having trouble backporting to 3.8. Reason: 'Error 110 while writing to socket. Connection timed out.'. Please retry by removing and re-adding the needs backport to 3.8 label.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 21, 2020
@keitherskine @miss-islington
PyLong_AsLongLong() docs should say 'long long' (pythonGH-18082)
c877594 
(cherry picked from commit 47be7d0)

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

GH-18109 is a backport of this pull request to the 3.7 branch.

@miss-islington
Copy link
Contributor

Thanks @keitherskine for the PR, and @mdickinson for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Thanks @keitherskine for the PR, and @mdickinson for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 21, 2020
@keitherskine @miss-islington
PyLong_AsLongLong() docs should say 'long long' (pythonGH-18082)
f86b9c7 
(cherry picked from commit 47be7d0)

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

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

mdickinson pushed a commit that referenced this pull request Jan 21, 2020
@miss-islington @keitherskine @mdickinson
PyLong_AsLongLong() docs should say 'long long' (GH-18082) (#18109)
d76ff72 
(cherry picked from commit 47be7d0)

Co-authored-by: Keith Erskine <[email protected]>

Co-authored-by: Keith Erskine <[email protected]>
mdickinson pushed a commit that referenced this pull request Jan 21, 2020
@miss-islington @keitherskine @mdickinson
PyLong_AsLongLong() docs should say 'long long' (GH-18082) (GH-18110)
41b3e87 
(cherry picked from commit 47be7d0)

Co-authored-by: Keith Erskine <[email protected]>

Co-authored-by: Keith Erskine <[email protected]>
@mdickinson
Copy link
Member

@keitherskine Thank you! Merged, and backported to 3.8 and 3.7.

shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
@keitherskine @shihai1991
PyLong_AsLongLong() docs should say 'long long' (python#18082)
2698f83
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdickinson mdickinson mdickinson approved these changes

@aeros aeros aeros approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@keitherskine @bedevere-bot @miss-islington @mdickinson @aeros @the-knights-who-say-ni