]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
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)
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

index 8eb0b35eaa12df6850b2810fc04b17557a2040bf..240ab139838db9f5c1b4cceee17dd1cb617787d5 100644 (file)
@@ -61,7 +61,7 @@ running from a virtual environment.
 A virtual environment may be "activated" using a script in its binary directory
 (``bin`` on POSIX; ``Scripts`` on Windows).
 This will prepend that directory to your :envvar:`!PATH`, so that running
-:program:`!python` will invoke the environment's Python interpreter
+:program:`python` will invoke the environment's Python interpreter
 and you can run installed scripts without having to use their full path.
 The invocation of the activation script is platform-specific
 (:samp:`{<venv>}` must be replaced by the path to the directory
@@ -84,7 +84,7 @@ containing the virtual environment):
 +-------------+------------+--------------------------------------------------+
 
 .. versionadded:: 3.4
-   :program:`!fish` and :program:`!csh` activation scripts.
+   :program:`fish` and :program:`csh` activation scripts.
 
 .. versionadded:: 3.8
    PowerShell activation scripts installed under POSIX for PowerShell Core
index 117be21a3221b609072b9d293c049af220246944..d871384903e7cd00c84281217a484195efe16465 100644 (file)
@@ -959,7 +959,7 @@ Fix ``make regen-test-levenshtein`` for out-of-tree builds.
 
 Don't use vendored ``libmpdec`` headers if :option:`--with-system-libmpdec`
 is passed to :program:`configure`. Don't use vendored ``libexpat`` headers
-if :option:`--with-system-expat` is passed to :program:`!configure`.
+if :option:`--with-system-expat` is passed to :program:`configure`.
 
 ..