Skip to content

Improve documentation for common sequence methods #138465

Closed
Closed
Improve documentation for common sequence methods#138465
Assignees
AA-Turner
Labels
docsDocumentation in the Doc dir

Description

@AA-Turner
AA-Turner
opened on Sep 3, 2025

From @serhiy-storchaka in #101100

My suggestion for stdtypes.rst:

Leave the statements and operators in the tables, but document all methods using normal Sphinx syntax, e.g.:

.. method:: sequence.append(value, /)

Then make anchors for list.append(), bytearray.append(), deque.append(), etc linked to this definition (there is a way to do this without cluttering the text and index). For example:

.. method:: list.append(value, /)
            bytearray.append(value, /)
   :no-typesetting:
   :no-index-entry:
.. method:: sequence.append(value, /)

Linked PRs

Activity

  1. AA-Turner
    self-assigned this
    on Sep 3, 2025
  2. AA-Turner
    added
    docsDocumentation in the Doc dir
    on Sep 3, 2025
  3. github-project-automation
    added this to docs issueson Sep 3, 2025
  4. github-project-automation
    moved this to Todo in docs issueson Sep 3, 2025
  5. AA-Turner
    added a commit that references this issue on Sep 5, 2025

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

    8ed1d53
  6. miss-islington
    added a commit that references this issue on Sep 5, 2025

    pythonGH-138465: Improve documentation for common sequence methods (p…

    d8d7327
  7. AA-Turner
    added 2 commits that reference this issue on Sep 5, 2025

    [3.13] pythonGH-138465: Improve documentation for common sequence met…

    07620ce

    [3.13] GH-138465: Improve documentation for common sequence methods (G…

    e7bb98a
  8. hugovk
    added a commit that references this issue on Sep 6, 2025

    [3.14] GH-138465: Improve documentation for common sequence methods (G…

    f153e32
  9. AA-Turner
    closed this as completedon Sep 6, 2025
  10. kumaraditya303
    added a commit that references this issue on Sep 9, 2025

    [3.14] pythonGH-138465: Improve documentation for common sequence met…

    ea7bfc7
  11. lkollar
    added a commit that references this issue on Sep 9, 2025

    pythonGH-138465: Improve documentation for common sequence methods (p…

    872cb17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions