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

bpo-38557: Improve documentation for list and tuple C API. #16925

Merged
merged 1 commit into from Oct 26, 2019
Merged

bpo-38557: Improve documentation for list and tuple C API. #16925

merged 1 commit into from Oct 26, 2019

Conversation

@serhiy-storchaka
Copy link
Member

serhiy-storchaka commented Oct 25, 2019 •
edited by bedevere-bot

https://bugs.python.org/issue38557
@serhiy-storchaka
bpo-38557: Improve documentation for list and tuple C API.
Loading status checks…
dbb8c59
@terryjreedy
terryjreedy approved these changes Oct 26, 2019
View changes
Copy link
Member

terryjreedy left a comment

I assume that the re-wordings and additions are technically correct. They otherwise look good to me.
Doc/c-api/list.rst
@@ -111,17 +112,16 @@ List Objects
Return a list of the objects in *list* containing the objects *between* *low*
and *high*. Return *NULL* and set an exception if unsuccessful. Analogous
to ``list[low:high]``. Negative indices, as when slicing from Python, are not
supported.
to ``list[low:high]``. Indexing from the end of the list is not supported.

This comment has been minimized.

Sign in to view
Copy link
@terryjreedy

terryjreedy Oct 26, 2019

Member

By itself, this is not obviously much of an improvement, but in the context of the earlier sentence for PyList_GetItem, "The position must be non-negative; indexing from the end of the list is not supported.", I think it is.

This comment has been minimized.

Sign in to view
Copy link
@serhiy-storchaka

serhiy-storchaka Oct 26, 2019

Author Member

Technically, negative indices are supported. But they do not count from the end.
@serhiy-storchaka serhiy-storchaka merged commit d898d20 into python:master Oct 26, 2019
4 checks passed
4 checks passed
Azure Pipelines PR #20191025.8 succeeded
Details
bedevere/issue-number Issue number 38557 found
Details
bedevere/news "skip news" label found
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@serhiy-storchaka serhiy-storchaka deleted the serhiy-storchaka:docs-tuple-getslice branch Oct 26, 2019
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Oct 26, 2019

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.7, 3.8.
🐍🍒⛏🤖
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Oct 26, 2019

GH-16933 is a backport of this pull request to the 3.8 branch.
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Oct 26, 2019

GH-16934 is a backport of this pull request to the 3.7 branch.
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Oct 26, 2019

GH-16935 is a backport of this pull request to the 2.7 branch.
miss-islington added a commit to miss-islington/cpython that referenced this pull request Oct 26, 2019
@serhiy-storchaka @miss-islington
bpo-38557: Improve documentation for list and tuple C API. (pythonGH-…
89c3972 
…16925)

(cherry picked from commit d898d20)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington added a commit to miss-islington/cpython that referenced this pull request Oct 26, 2019
@serhiy-storchaka @miss-islington
bpo-38557: Improve documentation for list and tuple C API. (pythonGH-…
1416db0 
…16925)

(cherry picked from commit d898d20)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington added a commit that referenced this pull request Oct 26, 2019
@miss-islington @serhiy-storchaka
bpo-38557: Improve documentation for list and tuple C API. (GH-16925)
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
7356e10 
(cherry picked from commit d898d20)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington added a commit that referenced this pull request Oct 26, 2019
@miss-islington @serhiy-storchaka
bpo-38557: Improve documentation for list and tuple C API. (GH-16925)
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
334fc92 
(cherry picked from commit d898d20)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington added a commit that referenced this pull request Oct 26, 2019
@miss-islington @serhiy-storchaka
bpo-38557: Improve documentation for list and tuple C API. (GH-16925)
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
4992dc6 
(cherry picked from commit d898d20)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
jacobneiltaylor added a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
@serhiy-storchaka @jacobneiltaylor
bpo-38557: Improve documentation for list and tuple C API. (pythonGH-…
d8abaa7 
…16925)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terryjreedy terryjreedy

Assignees
No one assigned
Labels
CLA signed skip news type-documentation
Projects
None yet
Milestone
No milestone
5 participants
@serhiy-storchaka @miss-islington @bedevere-bot @terryjreedy @the-knights-who-say-ni
You can’t perform that action at this time.