-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
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
gh-101100: Fix Sphinx warnings about list methods #127054
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
List methods are not documented in a way that we can refer to them: https://docs.python.org/dev/library/stdtypes.html#mutable-sequence-types
) (cherry picked from commit 3e81225) Co-authored-by: Yuki Kobayashi <[email protected]>
) (cherry picked from commit 3e81225) Co-authored-by: Yuki Kobayashi <[email protected]>
GH-127511 is a backport of this pull request to the 3.13 branch. |
GH-127512 is a backport of this pull request to the 3.12 branch. |
…127511) Co-authored-by: Yuki Kobayashi <[email protected]>
…127512) Co-authored-by: Yuki Kobayashi <[email protected]>
item to the top of the stack, use :meth:`!~list.append`. To retrieve an item from the | ||
top of the stack, use :meth:`!~list.pop` without an explicit index. For example:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@m-aciek Thank you for pointing this out. I'll fix it soon.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, it'd be good to detect this with the Sphinx Lint too. I reported it at:
The references starting with `!~` are not rendered correctly (as pointed out in python#127054 (comment))
… (pythonGH-127684) (cherry picked from commit 77a61c0) Co-authored-by: Yuki Kobayashi <[email protected]>
… (pythonGH-127684) (cherry picked from commit 77a61c0) Co-authored-by: Yuki Kobayashi <[email protected]>
The list methods have no entries in the document, so removed these references.
Fixed 7 sphinx warnings:
📚 Documentation preview 📚: https://cpython-previews--127054.org.readthedocs.build/