Skip to content

GH-138465: Improve documentation for common sequence methods#138474

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
AA-Turner merged 7 commits into from
Sep 5, 2025
Merged

GH-138465: Improve documentation for common sequence methods #138474

AA-Turner merged 7 commits into from
Sep 5, 2025

Conversation

@AA-Turner
Copy link
Member

@AA-TurnerAA-Turner commented Sep 3, 2025•
edited by github-actions bot
Loading

cc @serhiy-storchaka

As part of this I've gone through the rest of the documentation and updated cross-references to use sequence.{method} / list.{method} etc as appropriate.

A

📚 Documentation preview 📚: https://cpython-previews--138474.org.readthedocs.build/

@AA-TurnerAA-Turner added docs Documentation in the Doc dir skip news labels Sep 3, 2025
@AA-TurnerAA-Turner added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Sep 3, 2025
@bedevere-appbedevere-appbot mentioned this pull request Sep 3, 2025
Closed
@AA-TurnerAA-Turner mentioned this pull request Sep 3, 2025
Merged
serhiy-storchaka
serhiy-storchaka reviewed Sep 5, 2025
View reviewed changes
Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Looks great!

serhiy-storchaka
serhiy-storchaka reviewed Sep 5, 2025
View reviewed changes
Doc/reference/datamodel.rst
Mutable sequences should provide methods :meth:`~sequence.append`,
:meth:`~sequence.count`, :meth:`~sequence.index`, :meth:`~sequence.extend`,
:meth:`~sequence.insert`, :meth:`~sequence.pop`, :meth:`~sequence.remove`,
:meth:`~sequence.reverse` and :meth:`~sequence.sort`,
Copy link
Member

@serhiy-storchakaserhiy-storchakaSep 5, 2025

Choose a reason for hiding this comment

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

sequence.sort does not exist. But sequence.clear was omitted.

Copy link
MemberAuthor

@AA-TurnerAA-TurnerSep 5, 2025•
edited
Loading

Choose a reason for hiding this comment

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

This is unchanged text (the only difference is fixed cross-references). Please could we leave it to a different issue to change, if needed?

Copy link
MemberAuthor

@AA-TurnerAA-TurnerSep 5, 2025

Choose a reason for hiding this comment

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

Opened #138562

serhiy-storchaka
serhiy-storchaka approved these changes Sep 5, 2025
View reviewed changes
Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM. 👍

@AA-TurnerAA-Turner merged commit 8ed1d53 into python:mainSep 5, 2025
31 checks passed
@miss-islington-app
Copy link

miss-islington-appbot commented Sep 5, 2025

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@AA-TurnerAA-Turner deleted the docs/refwarn/stdtypes-methods branch September 5, 2025 19:55
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsSep 5, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 5, 2025
@AA-Turner@serhiy-storchaka@miss-islington
pythonGH-138465: Improve documentation for common sequence methods (p…
d8d7327
…ythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@miss-islington-app
Copy link

miss-islington-appbot commented Sep 5, 2025

Sorry, @AA-Turner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 8ed1d53e62aa9acb9a0674f479cfe4d06622b911 3.13

@bedevere-app
Copy link

bedevere-appbot commented Sep 5, 2025

GH-138560 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.14 bugs and security fixes label Sep 5, 2025
@AA-TurnerAA-Turner mentioned this pull request Sep 5, 2025
Closed
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Sep 5, 2025
@AA-Turner@serhiy-storchaka
[3.13]pythonGH-138465: Improve documentation for common sequence met…
07620ce
…hods (pythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app
Copy link

bedevere-appbot commented Sep 5, 2025

GH-138567 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Sep 5, 2025
AA-Turner added a commit that referenced this pull request Sep 5, 2025
@AA-Turner@serhiy-storchaka
[3.13]GH-138465: Improve documentation for common sequence methods (G…
e7bb98a
…H-138474) (#138567) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk pushed a commit that referenced this pull request Sep 6, 2025
@miss-islington@AA-Turner@serhiy-storchaka
[3.14]GH-138465: Improve documentation for common sequence methods (G…
f153e32
…H-138474) (#138560) GH-138465: Improve documentation for common sequence methods (GH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington@AA-Turner
@serhiy-storchaka@kumaraditya303
[3.14]pythonGH-138465: Improve documentation for common sequence met…
ea7bfc7
…hods (pythonGH-138474) (python#138560) pythonGH-138465: Improve documentation for common sequence methods (pythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
lkollar pushed a commit to lkollar/cpython that referenced this pull request Sep 9, 2025
@AA-Turner@serhiy-storchaka@lkollar
pythonGH-138465: Improve documentation for common sequence methods (p…
872cb17
…ython#138474) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

@rhettingerrhettingerAwaiting requested review from rhettingerrhettinger is a code owner

@willingcwillingcAwaiting requested review from willingcwillingc is a code owner

@hugovkhugovkAwaiting requested review from hugovkhugovk is a code owner

Assignees

@AA-TurnerAA-Turner

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AA-Turner@serhiy-storchaka