Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

koyuki7w
Copy link
Contributor

@koyuki7w koyuki7w commented Nov 20, 2024

The list methods have no entries in the document, so removed these references.

Fixed 7 sphinx warnings:

library/collections.rst:784: WARNING: py:meth reference target not found: list.append [ref.meth]
library/collections.rst:784: WARNING: py:meth reference target not found: list.append [ref.meth]
tutorial/datastructures.rst:143: WARNING: py:meth reference target not found: list.append [ref.meth]
tutorial/datastructures.rst:143: WARNING: py:meth reference target not found: list.pop [ref.meth]
tutorial/datastructures.rst:342: WARNING: py:meth reference target not found: list.pop [ref.meth]
tutorial/datastructures.rst:495: WARNING: py:meth reference target not found: list.append [ref.meth]
tutorial/datastructures.rst:495: WARNING: py:meth reference target not found: list.extend [ref.meth]

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

Copy link
Member

@vstinner vstinner left a 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

@rhettinger rhettinger removed their request for review November 21, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants