Skip to content

Commit 6b6c2f5

Browse files
hugovktom93
andauthored
[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]: #98350 (comment) [3]: #98350 (comment) Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Tom Levy <tomlevy93@gmail.com>
1 parent 8aa07b9 commit 6b6c2f5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Doc/library/venv.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ running from a virtual environment.
6161
A virtual environment may be "activated" using a script in its binary directory
6262
(``bin`` on POSIX; ``Scripts`` on Windows).
6363
This will prepend that directory to your :envvar:`!PATH`, so that running
64-
:program:`!python` will invoke the environment's Python interpreter
64+
:program:`python` will invoke the environment's Python interpreter
6565
and you can run installed scripts without having to use their full path.
6666
The invocation of the activation script is platform-specific
6767
(:samp:`{<venv>}` must be replaced by the path to the directory
@@ -84,7 +84,7 @@ containing the virtual environment):
8484
+-------------+------------+--------------------------------------------------+
8585

8686
.. versionadded:: 3.4
87-
:program:`!fish` and :program:`!csh` activation scripts.
87+
:program:`fish` and :program:`csh` activation scripts.
8888

8989
.. versionadded:: 3.8
9090
PowerShell activation scripts installed under POSIX for PowerShell Core

0 commit comments

Comments
 (0)