Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-101100: Fix Sphinx warnings from removed~! references#113629

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedJan 1, 2024•
edited
Loading

Fix 23 warnings for things like:meth:`~!unittest.TestProgram.usageExit` - the tilde says to render it likeusageExit and the exclamation mark says not to look up the reference.

But after deprecations have been removed, Sphinx nevertheless issues a warning. So instead let's switch to:meth:`!usageExit` to show the short version and not look it up. This silences the warning.

Doc/whatsnew/3.11.rst:1863: WARNING: py:meth reference target not found: !unittest.TestProgram.usageExitDoc/whatsnew/3.3.rst:1055: WARNING: py:func reference target not found: !crypt.mksaltDoc/whatsnew/3.4.rst:1531: WARNING: py:meth reference target not found: !sunau.getparamsDoc/whatsnew/3.4.rst:1543: WARNING: py:meth reference target not found: !sunau.AU_write.writeframesDoc/whatsnew/3.4.rst:1543: WARNING: py:meth reference target not found: !sunau.AU_write.writeframesrawDoc/whatsnew/3.4.rst:608: WARNING: py:meth reference target not found: !aifc.aifc.getparamsDoc/whatsnew/3.4.rst:611: WARNING: py:meth reference target not found: !aifc.aifc.closeDoc/whatsnew/3.4.rst:616: WARNING: py:meth reference target not found: !aifc.aifc.writeframesDoc/whatsnew/3.4.rst:616: WARNING: py:meth reference target not found: !aifc.aifc.writeframesrawDoc/whatsnew/3.4.rst:635: WARNING: py:func reference target not found: !audioop.byteswapDoc/whatsnew/3.5.rst:1255: WARNING: py:func reference target not found: !imghdr.whatDoc/whatsnew/3.7.rst:2006: WARNING: py:meth reference target not found: !importlib.abc.MetaPathFinder.find_moduleDoc/whatsnew/3.7.rst:2006: WARNING: py:meth reference target not found: !importlib.abc.PathEntryFinder.find_loaderDoc/whatsnew/3.7.rst:854: WARNING: py:func reference target not found: !crypt.mksaltDoc/whatsnew/3.9.rst:588: WARNING: py:class reference target not found: !nntplib.NNTPDoc/whatsnew/3.9.rst:588: WARNING: py:class reference target not found: !nntplib.NNTP_SSLbuild/NEWS:10243: WARNING: py:meth reference target not found: !unittest.TestProgram.usageExitbuild/NEWS:14046: WARNING: py:func reference target not found: !unittest.findTestCasesbuild/NEWS:14047: WARNING: py:func reference target not found: !unittest.makeSuitebuild/NEWS:14048: WARNING: py:func reference target not found: !unittest.getTestCaseNamesbuild/NEWS:20562: WARNING: py:class reference target not found: !nntplib.NNTPbuild/NEWS:20562: WARNING: py:class reference target not found: !nntplib.NNTP_SSLbuild/NEWS:20578: WARNING: py:class reference target not found: !nntplib.NNTP

And for future removals, instead of doing:

-:meth:`~unittest.TestProgram.usageExit`+:meth:`~!unittest.TestProgram.usageExit`

Let's prefer:

-:meth:`~unittest.TestProgram.usageExit`+:meth:`!usageExit`

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

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

Looks good!

hugovk reacted with rocket emoji
@hugovkhugovk merged commit7595380 intopython:mainJan 2, 2024
@hugovkhugovk deleted the docs-fix-sphinx-warnings-squiggle-bang branchJanuary 2, 2024 07:37
@miss-islington-app
Copy link

Thanks@hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 7595380347610598a3f5529214a449660892537b 3.12

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 7595380347610598a3f5529214a449660892537b 3.11

hugovk added a commit to hugovk/cpython that referenced this pull requestJan 2, 2024
…ces (pythonGH-113629)(cherry picked from commit7595380)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app
Copy link

GH-113641 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelJan 2, 2024
@bedevere-app
Copy link

GH-113642 is a backport of this pull request to the3.11 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelJan 2, 2024
hugovk added a commit to hugovk/cpython that referenced this pull requestJan 2, 2024
…ces (pythonGH-113629)(cherry picked from commit7595380)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull requestJan 2, 2024
…H-113629) (#113641)(cherry picked from commit7595380)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull requestJan 2, 2024
…H-113629) (#113642)(cherry picked from commit7595380)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull requestJan 22, 2024
aisk pushed a commit to aisk/cpython that referenced this pull requestFeb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull requestSep 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

@hugovkhugovk

Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@hugovk@AlexWaygood
[8]ページ先頭
©2009-2025 Movatter.jp