gh-101100: Fix Sphinx reference warnings#112416
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
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
Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes
… in library/email.headerregistry.rst
On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs
hugovk added docs 
hugovk requested review from a team, 1st1, asvetlov, brettcannon, ericsnowcurrently, gvanrossum, kumaraditya303, ncoghlan, warsaw and willingc as code ownershugovk removed request for ericsnowcurrently, gvanrossum, kumaraditya303, ncoghlan and willingc
willingc approved these changes Nov 25, 2023
Sorry, @hugovk and @willingc, I could not cleanly backport this to |
Sorry, @hugovk and @willingc, I could not cleanly backport this to |
| Return ``1`` if found and removed, ``0`` if not found (no action taken), and ``-1`` if an | ||
| error is encountered. Does not raise :exc:`KeyError` for missing keys. Raise a | ||
| :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~set.discard` | ||
| :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~frozenset.discard` |
Member
There was a problem hiding this comment.
Ideally we'd fix it so that the original linked properly, given that frozensets don't have a .discard() method, but sets do 🙃
MemberAuthor
There was a problem hiding this comment.
Good idea, although I'm not sure how to do it. PR welcome! 🙃
Contributor
@hugovk or @AlexWaygood Would you mind doing the backports? I'm getting ready for a flight to Japan so will be offline for a while. Thanks! |
MemberAuthor
hugovk commented Nov 26, 2023
Yes, I'll take care of the backports. Enjoy your trip! |
hugovk added a commit to hugovk/cpython that referenced this pull request Nov 26, 2023
* Fix Sphinx warning in library/xml.rst Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes * Fix Sphinx warning in library/importlib.resources.rst * Use italics for parameters * Link to the exception * Fix Sphinx warning in library/gzip.rst * Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst * Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst * Fix Sphinx warning in extending/newtypes.rst * Fix Sphinx warning in c-api/set.rst On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs (cherry picked from commit 3faf8e5) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit to hugovk/cpython that referenced this pull request Nov 26, 2023
* Fix Sphinx warning in library/xml.rst Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes * Fix Sphinx warning in library/importlib.resources.rst * Use italics for parameters * Link to the exception * Fix Sphinx warning in library/gzip.rst * Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst * Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst * Fix Sphinx warning in extending/newtypes.rst * Fix Sphinx warning in c-api/set.rst On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs (cherry picked from commit 3faf8e5) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
GH-112420 is a backport of this pull request to the 3.12 branch. |
GH-112422 is a backport of this pull request to the 3.11 branch. |
hugovk added a commit to hugovk/cpython that referenced this pull request Nov 26, 2023
* Fix Sphinx warning in library/xml.rst Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes * Fix Sphinx warning in library/importlib.resources.rst * Use italics for parameters * Link to the exception * Fix Sphinx warning in library/gzip.rst * Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst * Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst * Fix Sphinx warning in extending/newtypes.rst * Fix Sphinx warning in c-api/set.rst On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs (cherry picked from commit 3faf8e5) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Nov 26, 2023
hugovk added a commit that referenced this pull request Nov 26, 2023
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
* Fix Sphinx warning in library/xml.rst Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes * Fix Sphinx warning in library/importlib.resources.rst * Use italics for parameters * Link to the exception * Fix Sphinx warning in library/gzip.rst * Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst * Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst * Fix Sphinx warning in extending/newtypes.rst * Fix Sphinx warning in c-api/set.rst On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
* Fix Sphinx warning in library/xml.rst Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes * Fix Sphinx warning in library/importlib.resources.rst * Use italics for parameters * Link to the exception * Fix Sphinx warning in library/gzip.rst * Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst * Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst * Fix Sphinx warning in extending/newtypes.rst * Fix Sphinx warning in c-api/set.rst On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix 7 Sphinx warnings, in most files with a single warning:
Plus a bit of extra cleanup, details in commits.
📚 Documentation preview 📚: https://cpython-previews--112416.org.readthedocs.build/