Skip to content

/ cpython

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

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

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
+1 −1

Conversation

@keitherskine
Copy link
Contributor

keitherskine commented Jan 20, 2020

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.
@keitherskine
PyLong_AsLongLong() docs should say 'long long'
Loading status checks…
b8a0247
@aeros
aeros approved these changes Jan 20, 2020
View changes
Copy link
Member

aeros left a comment •
edited

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 Jan 20, 2020
@keitherskine

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

keitherskine commented Jan 21, 2020

Many thanks @aeros , sounds good!
@mdickinson
mdickinson approved these changes Jan 21, 2020
View changes
Copy link
Member

mdickinson left a comment

LGTM
@mdickinson mdickinson merged commit 47be7d0 into python:master Jan 21, 2020
5 checks passed
5 checks passed
Docs
Details
Azure Pipelines PR #20200120.19 succeeded
Details
bedevere/issue-number Issue report skipped
bedevere/news "skip news" label found
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Jan 21, 2020

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

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 21, 2020

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

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 21, 2020

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 added 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 <toastie604@gmail.com>
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Jan 21, 2020

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

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 21, 2020

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

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 21, 2020

Thanks @keitherskine for the PR, and @mdickinson for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖
miss-islington added 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 <toastie604@gmail.com>
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Jan 21, 2020

GH-18110 is a backport of this pull request to the 3.8 branch.
mdickinson added a commit that referenced this pull request Jan 21, 2020
@miss-islington @keitherskine @mdickinson
PyLong_AsLongLong() docs should say 'long long' (GH-18082) (#18109)
Loading status checks…
d76ff72 
(cherry picked from commit 47be7d0)

Co-authored-by: Keith Erskine <toastie604@gmail.com>

Co-authored-by: Keith Erskine <toastie604@gmail.com>
mdickinson added 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)
Loading status checks…
41b3e87 
(cherry picked from commit 47be7d0)

Co-authored-by: Keith Erskine <toastie604@gmail.com>

Co-authored-by: Keith Erskine <toastie604@gmail.com>
@mdickinson

This comment has been minimized.

Sign in to view
Copy link
Member

mdickinson commented Jan 21, 2020

@keitherskine Thank you! Merged, and backported to 3.8 and 3.7.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdickinson mdickinson

@aeros aeros

Assignees
No one assigned
Labels
CLA signed needs backport to 3.7 skip issue skip news type-documentation
Projects
None yet
Milestone
No milestone
6 participants
@keitherskine @bedevere-bot @miss-islington @mdickinson @aeros @the-knights-who-say-ni
You can’t perform that action at this time.