FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warnings about list methods · Pull Request #127054 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix Sphinx warnings about list methods - #127054

Merged
hugovk merged 2 commits into
mainfrom
unknown repository
Dec 2, 2024
ConversationCommits (2)ChecksFiles changed
Merged

gh-101100: Fix Sphinx warnings about list methods#127054
hugovk merged 2 commits into
mainfrom
unknown repository

Conversation

ghost commented Nov 20, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown

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/

ghost requested a review from rhettinger as a code owner November 20, 2024 10:15
bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Nov 20, 2024
bedevere-app Bot mentioned this pull request Nov 20, 2024
Closed
picnixz requested a review from AA-Turner November 21, 2024 05:36
vstinner approved these changes Nov 21, 2024
View reviewed changes

vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 removed their request for review November 21, 2024 17:36
hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Nov 24, 2024
hugovk merged commit 3e81225 into python:main Dec 2, 2024

miss-islington-app Bot commented Dec 2, 2024

Copy link
Copy Markdown

Thanks @koyuki7w for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 2, 2024
pythongh-101100: Fix Sphinx warnings about list methods (pythonGH-127054
d6d53ef 
)

(cherry picked from commit 3e81225)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 2, 2024
pythongh-101100: Fix Sphinx warnings about list methods (pythonGH-127054
f87604e 
)

(cherry picked from commit 3e81225)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>

bedevere-app Bot commented Dec 2, 2024

Copy link
Copy Markdown

GH-127511 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Dec 2, 2024

bedevere-app Bot commented Dec 2, 2024

Copy link
Copy Markdown

GH-127512 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Dec 2, 2024
ghost deleted the doc-fix-1 branch December 2, 2024 13:52
hugovk pushed a commit that referenced this pull request Dec 2, 2024
[3.13] gh-101100: Fix Sphinx warnings about list methods (GH-127054) (#…
26f1e88 
…127511)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
hugovk pushed a commit that referenced this pull request Dec 2, 2024
[3.12] gh-101100: Fix Sphinx warnings about list methods (GH-127054) (#…
179b134 
…127512)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
m-aciek reviewed Dec 6, 2024
View reviewed changes
Comment thread Doc/tutorial/datastructures.rst
Comment on lines +145 to +146
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::

m-aciek Dec 6, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This change apparently broke the rendering, we don't want to display the tilde character. The exclamation mark should probably replace the tilde?

ghost Dec 6, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@m-aciek Thank you for pointing this out. I'll fix it soon.

hugovk Dec 6, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks, it'd be good to detect this with the Sphinx Lint too. I reported it at:

sphinx-contrib/sphinx-lint#126

ghost mentioned this pull request Dec 6, 2024
Merged
hugovk mentioned this pull request Dec 6, 2024
Closed
hugovk pushed a commit that referenced this pull request Dec 6, 2024
gh-101100: amend references starting with !~ in gh-127054 (#127684)
77a61c0
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 6, 2024
pythongh-101100: amend references starting with !~ in pythongh-127054…
0acc5f3 
… (pythonGH-127684)

(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 6, 2024
pythongh-101100: amend references starting with !~ in pythongh-127054…
959e932 
… (pythonGH-127684)

(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
hugovk pushed a commit that referenced this pull request Dec 6, 2024
[3.13] gh-101100: amend references starting with !~ in gh-127054 (G…
5d35d27 
…H-127684) (#127692)

gh-101100: amend references starting with `!~` in gh-127054 (GH-127684)
(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
hugovk pushed a commit that referenced this pull request Dec 6, 2024
[3.12] gh-101100: amend references starting with !~ in gh-127054 (G…
cd46fb6 
…H-127684) (#127693)

gh-101100: amend references starting with `!~` in gh-127054 (GH-127684)
(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
pythongh-101100: Fix Sphinx warnings about list methods (python#127054)
f95141e
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
pythongh-101100: amend references starting with !~ in pythongh-127054…
417c5ce 
… (python#127684)
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
pythongh-101100: Fix Sphinx warnings about list methods (python#127054)
0b6ef61
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL