]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
Remove misformatted exclamation marks in docs (#102694)
authorTom Levy <tomlevy93@gmail.com>
Wed, 15 Mar 2023 07:06:32 +0000 (20:06 +1300)
committerGitHub <noreply@github.com>
Wed, 15 Mar 2023 07:06:32 +0000 (09:06 +0200)
commit8647ba4b639077e201751ae6dbd82e8bfcf80895
treea3f41d07fba4548a04adec4be21fa1f4542b12b3
parent5e0865f22eed9f3f3f0e912c4ada196effbd8ce0
Remove misformatted exclamation marks in docs (#102694)

Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.

(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)

The exclamation marks in venv.rst were introduced in #98350. See
comments [2] and [3] for additional discussion.

[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047

Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Doc/library/venv.rst
Misc/NEWS.d/3.12.0a2.rst