Title: gh-101100: Fix Sphinx warnings from removed `~!` references by hugovk · Pull Request #113629 · python/cpython · GitHub
Open Graph Title: gh-101100: Fix Sphinx warnings from removed `~!` references by hugovk · Pull Request #113629 · python/cpython
X Title: gh-101100: Fix Sphinx warnings from removed `~!` references by hugovk · Pull Request #113629 · python/cpython
Description: Fix 23 warnings for things like :meth:`~!unittest.TestProgram.usageExit` - the tilde says to render it like usageExit 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.usageExit Doc/whatsnew/3.3.rst:1055: WARNING: py:func reference target not found: !crypt.mksalt Doc/whatsnew/3.4.rst:1531: WARNING: py:meth reference target not found: !sunau.getparams Doc/whatsnew/3.4.rst:1543: WARNING: py:meth reference target not found: !sunau.AU_write.writeframes Doc/whatsnew/3.4.rst:1543: WARNING: py:meth reference target not found: !sunau.AU_write.writeframesraw Doc/whatsnew/3.4.rst:608: WARNING: py:meth reference target not found: !aifc.aifc.getparams Doc/whatsnew/3.4.rst:611: WARNING: py:meth reference target not found: !aifc.aifc.close Doc/whatsnew/3.4.rst:616: WARNING: py:meth reference target not found: !aifc.aifc.writeframes Doc/whatsnew/3.4.rst:616: WARNING: py:meth reference target not found: !aifc.aifc.writeframesraw Doc/whatsnew/3.4.rst:635: WARNING: py:func reference target not found: !audioop.byteswap Doc/whatsnew/3.5.rst:1255: WARNING: py:func reference target not found: !imghdr.what Doc/whatsnew/3.7.rst:2006: WARNING: py:meth reference target not found: !importlib.abc.MetaPathFinder.find_module Doc/whatsnew/3.7.rst:2006: WARNING: py:meth reference target not found: !importlib.abc.PathEntryFinder.find_loader Doc/whatsnew/3.7.rst:854: WARNING: py:func reference target not found: !crypt.mksalt Doc/whatsnew/3.9.rst:588: WARNING: py:class reference target not found: !nntplib.NNTP Doc/whatsnew/3.9.rst:588: WARNING: py:class reference target not found: !nntplib.NNTP_SSL build/NEWS:10243: WARNING: py:meth reference target not found: !unittest.TestProgram.usageExit build/NEWS:14046: WARNING: py:func reference target not found: !unittest.findTestCases build/NEWS:14047: WARNING: py:func reference target not found: !unittest.makeSuite build/NEWS:14048: WARNING: py:func reference target not found: !unittest.getTestCaseNames build/NEWS:20562: WARNING: py:class reference target not found: !nntplib.NNTP build/NEWS:20562: WARNING: py:class reference target not found: !nntplib.NNTP_SSL build/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` Issue: gh-101100 📚 Documentation preview 📚: https://cpython-previews--113629.org.readthedocs.build/
Open Graph Description: Fix 23 warnings for things like :meth:`~!unittest.TestProgram.usageExit` - the tilde says to render it like usageExit and the exclamation mark says not to look up the reference. But after deprecati...
X Description: Fix 23 warnings for things like :meth:`~!unittest.TestProgram.usageExit` - the tilde says to render it like usageExit and the exclamation mark says not to look up the reference. But after deprecati...
Opengraph URL: https://github.com/python/cpython/pull/113629
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:eeca0ba1-285d-203d-8106-88afe1de001d |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | 8FCE:33C049:820717:AFFC26:6969DF53 |
| html-safe-nonce | bd074001cd741bb03667a1d08c53b1ef0e4744cc1a5edfdfb077e0df3611fae3 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RkNFOjMzQzA0OTo4MjA3MTc6QUZGQzI2OjY5NjlERjUzIiwidmlzaXRvcl9pZCI6Ijg4NDEzNjA4MjM5MzAxODM1MDgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 554c5bde5957d7d4692af4dad42293436ae7197636672211a37191a8fdd94709 |
| hovercard-subject-tag | pull_request:1661246627 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/113629/checks |
| twitter:image | https://avatars.githubusercontent.com/u/1324225?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1324225?s=400&v=4 |
| og:image:alt | Fix 23 warnings for things like :meth:`~!unittest.TestProgram.usageExit` - the tilde says to render it like usageExit and the exclamation mark says not to look up the reference. But after deprecati... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7b32f1c7c4549428ee399213e8345494fc55b5637195d3fc5f493657579235e8 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | bdde15ad1b403e23b08bbd89b53fbe6bdf688cad |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width