]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.11] Remove misformatted exclamation marks in docs (GH-102694) (#102716)
authorHugo van Kemenade <hugovk@users.noreply.github.com>
Wed, 15 Mar 2023 07:25:55 +0000 (09:25 +0200)
committerGitHub <noreply@github.com>
Wed, 15 Mar 2023 07:25:55 +0000 (09:25 +0200)
commit6b6c2f53ec7ae216532bd0995c2cfc8f46d69711
tree57afd37588693c696be86391fd5d9b2908dbf3f7
parent8aa07b9c8ae0203aa6e85b2b5556ee1700525672
[3.11] Remove misformatted exclamation marks in docs (GH-102694) (#102716)

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>
Co-authored-by: Tom Levy <tomlevy93@gmail.com>
Doc/library/venv.rst