Skip to content

gh-144837: Improve documentation for more collection methods#144841

Open
serhiy-storchaka wants to merge 1 commit intopython:mainfrom
serhiy-storchaka:docs-collections-signatures
Open

gh-144837: Improve documentation for more collection methods#144841
serhiy-storchaka wants to merge 1 commit intopython:mainfrom
serhiy-storchaka:docs-collections-signatures

Conversation

@serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Feb 15, 2026

Use uniform standard signature syntax in the tutorial and in the array and collections modules documentation.


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

Use uniform standard signature syntax in the tutorial and in
the array and collections modules documentation.
.. method:: append(value, /)

Append a new item with value *x* to the end of the array.
Append a new item with the specified value to the end of the array.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Append a new item with the specified value to the end of the array.
Append a new item with the specified *value* to the end of the array.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure about this. I tried to avoid value *value*.

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

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants