Skip to content

Improve documentation for common sequence methods #138465

@AA-Turner

Description

@AA-Turner

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

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions