-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
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 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 from removed ~!
references
#113629
Conversation
Co-authored-by: Alex Waygood <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
Sorry, @hugovk, I could not cleanly backport this to
|
Sorry, @hugovk, I could not cleanly backport this to
|
…ces (pythonGH-113629) (cherry picked from commit 7595380) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
GH-113641 is a backport of this pull request to the 3.12 branch. |
GH-113642 is a backport of this pull request to the 3.11 branch. |
…ces (pythonGH-113629) (cherry picked from commit 7595380) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
…H-113629) (#113641) (cherry picked from commit 7595380) Co-authored-by: Alex Waygood <[email protected]>
…H-113629) (#113642) (cherry picked from commit 7595380) Co-authored-by: Alex Waygood <[email protected]>
…thon#113629) Co-authored-by: Alex Waygood <[email protected]>
…thon#113629) Co-authored-by: Alex Waygood <[email protected]>
…thon#113629) Co-authored-by: Alex Waygood <[email protected]>
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.And for future removals, instead of doing:
Let's prefer:
📚 Documentation preview 📚: https://cpython-previews--113629.org.readthedocs.build/