Skip to content

Commit

Permalink
[3.11] Remove misformatted exclamation marks in docs (pythonGH-102694)
Browse files Browse the repository at this point in the history
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 pythonGH-98350. See
comments [2] and [3] for additional discussion.

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

Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>.
(cherry picked from commit 8647ba4)

Co-authored-by: Tom Levy <tomlevy93@gmail.com>
  • Loading branch information
tom93 authored and hugovk committed Mar 15, 2023
1 parent 8aa07b9 commit 71098e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Doc/library/venv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 71098e4

Please sign in to comment.