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

GH-101100: Resolve reference warnings in library/stdtypes.rst by AA-Turner · Pull Request #138420 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

GH-101100: Resolve reference warnings in library/stdtypes.rst - #138420

Merged
AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:docs/refwarn/stdtypes
Nov 22, 2025
ConversationCommits (3)ChecksFiles changed
Merged

GH-101100: Resolve reference warnings in library/stdtypes.rst#138420
AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:docs/refwarn/stdtypes

Conversation

AA-Turner commented Sep 3, 2025 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

AA-Turner requested a review from hugovk as a code owner September 3, 2025 00:26
AA-Turner added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes labels Sep 3, 2025
bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Sep 3, 2025
github-project-automation Bot moved this to Todo in Docs PRs Sep 3, 2025
AA-Turner changed the title Resolve reference warnings in library/stdtypes.rst GH-101100: Resolve reference warnings in library/stdtypes.rst Sep 3, 2025
bedevere-app Bot mentioned this pull request Sep 3, 2025
Closed

serhiy-storchaka commented Sep 3, 2025

Copy link
Copy Markdown
Member

I think that the right fix for this is to add anchors instead of removing references.

aisk reviewed Sep 3, 2025
View reviewed changes
Comment thread Doc/library/stdtypes.rst

AA-Turner commented Sep 3, 2025

Copy link
Copy Markdown
Member Author

@serhiy-storchaka I've generally been hesitant to suppress cross-references, but I think all the instances here make sense, given their context. Are there some specific ones you would revert?

A

serhiy-storchaka reviewed Sep 3, 2025
View reviewed changes
Comment thread Doc/library/stdtypes.rst
another set. The :class:`frozenset` type is immutable and :term:`hashable` ---
its contents cannot be altered after it is created; it can therefore be used as
a dictionary key or as an element of another set.
like :meth:`add <frozenset.add>` and :meth:`remove <frozenset.add>`.

serhiy-storchaka Sep 3, 2025

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

There is no frozenset.add().

AA-Turner Sep 3, 2025

Copy link
Copy Markdown
Member 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

Because set and frozenset are documented together, there is no cross-reference target for set.add, it is labelled as frozenset.add instead. This link goes to the correct place.

serhiy-storchaka Sep 3, 2025

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

But this is a wrong name for anchor. We should do something with this.

AA-Turner Sep 3, 2025

Copy link
Copy Markdown
Member 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

I agree. I plan to fix it, but it requires changes (& a release) of Sphinx. This PR makes the reference link to the right place, and more importantly means that no future reference errors can be introduced into stdtypes.rst.

Once it is fixed, I plan to go back and update here & a few other places where we have used a different target to the intended one.

serhiy-storchaka Sep 6, 2025

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

Now, I think that we should reorganize the set/frozenset documentation in the way similar to the sequence or bytes/bytearray documentation.

  1. Dedent method descriptions and add class name prefixes. E.g.: 
    .. method:: frozenset.isdisjoint(other, /)
            set.isdisjoint(other, /)
  2. Move operators to separate tables. This may wait.

serhiy-storchaka Nov 22, 2025

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

#141857 implements this approach.

serhiy-storchaka commented Sep 3, 2025

Copy link
Copy Markdown
Member

Are there some specific ones you would revert?

All of them? See my suggestion #101100 (comment) . After implementing it the references in footnotes will gone, as they will become the part of the method description, and many other references will became working. After that we can check what remains.

AA-Turner commented Sep 3, 2025

Copy link
Copy Markdown
Member Author

See #138474, putting this in draft for now.

A

AA-Turner marked this pull request as draft September 3, 2025 21:00
Merge branch 'main' into docs/refwarn/stdtypes
b06ed6f 
# Conflicts:
#	Doc/library/stdtypes.rst
AA-Turner marked this pull request as ready for review September 5, 2025 20:58

hugovk commented Nov 22, 2025

Copy link
Copy Markdown
Member

(Resolved conflict)

AA-Turner merged commit cde19e5 into python:main Nov 22, 2025
28 checks passed
github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 22, 2025

miss-islington-app Bot commented Nov 22, 2025

Copy link
Copy Markdown

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 22, 2025
pythonGH-101100: Resolve reference warnings in library/stdtypes.rst (p…
f82a0a5 
…ythonGH-138420)

(cherry picked from commit cde19e5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

bedevere-app Bot commented Nov 22, 2025

Copy link
Copy Markdown

GH-141855 is a backport of this pull request to the 3.14 branch.

miss-islington-app Bot commented Nov 22, 2025

Copy link
Copy Markdown

Sorry, @AA-Turner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker cde19e565cc9127fe5db38358ebf3bbd75a9d2cd 3.13

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 22, 2025
hugovk pushed a commit that referenced this pull request Nov 22, 2025
[3.14] GH-101100: Resolve reference warnings in library/stdtypes.rst (G…
adc2cc2 
…H-138420) (#141855)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
serhiy-storchaka reviewed Nov 22, 2025
View reviewed changes
Comment thread Doc/library/stdtypes.rst
another set. The :class:`frozenset` type is immutable and :term:`hashable` ---
its contents cannot be altered after it is created; it can therefore be used as
a dictionary key or as an element of another set.
like :meth:`add <frozenset.add>` and :meth:`remove <frozenset.add>`.

serhiy-storchaka Nov 22, 2025

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

Wrong reverence to remove().

StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
[3.13] pythonGH-101100: Resolve reference warnings in library/stdtype…
fa960d3 
…s.rst (pythonGH-138420)

(cherry picked from commit cde19e5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

StanFromIreland commented Dec 6, 2025

Copy link
Copy Markdown
Member

We actually don't need to backport this, it is superseded by the backport of 1d8f3ed, #142345.

StanFromIreland removed the needs backport to 3.13 only security fixes label Dec 6, 2025
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
pythonGH-101100: Resolve reference warnings in library/stdtypes.rst (p…
a65a6e0 
…ython#138420)
ashm-dev pushed a commit to ashm-dev/cpython that referenced this pull request Dec 8, 2025
pythonGH-101100: Resolve reference warnings in library/stdtypes.rst (p…
9739b12 
…ython#138420)
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

aisk aisk left review comments
serhiy-storchaka serhiy-storchaka left review comments
hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees

AA-Turner

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.

5 participants

Back | FazBrowse Home | New Git URL