diff options
| author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2023-03-15 07:26:46 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-15 07:26:46 (GMT) |
| commit | 087fb56b9de2eedd5061619eda6fa98ee12738fc (patch) | |
| tree | ba4a15ed2ed55d36f5102022a4906499d666488e | |
| parent | 6f4df729bd0b01ae1221f0aba8775f4e3da337e9 (diff) | |
| download | cpython-087fb56b9de2eedd5061619eda6fa98ee12738fc.zip cpython-087fb56b9de2eedd5061619eda6fa98ee12738fc.tar.gz cpython-087fb56b9de2eedd5061619eda6fa98ee12738fc.tar.bz2 | |
[3.10] Remove misformatted exclamation marks in docs (GH-102694) (#102717)
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>
| -rw-r--r-- | Doc/library/venv.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 3ab83a2..401f02c 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -59,7 +59,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 @@ -82,7 +82,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 |