diff options
| author | Tom Levy <tomlevy93@gmail.com> | 2023-03-15 07:06:32 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-15 07:06:32 (GMT) |
| commit | 8647ba4b639077e201751ae6dbd82e8bfcf80895 (patch) | |
| tree | a3f41d07fba4548a04adec4be21fa1f4542b12b3 | |
| parent | 5e0865f22eed9f3f3f0e912c4ada196effbd8ce0 (diff) | |
| download | cpython-8647ba4b639077e201751ae6dbd82e8bfcf80895.zip cpython-8647ba4b639077e201751ae6dbd82e8bfcf80895.tar.gz cpython-8647ba4b639077e201751ae6dbd82e8bfcf80895.tar.bz2 | |
Remove misformatted exclamation marks in docs (#102694)
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>
| -rw-r--r-- | Doc/library/venv.rst | 4 | ||||
| -rw-r--r-- | Misc/NEWS.d/3.12.0a2.rst | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 8eb0b35..240ab13 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -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 diff --git a/Misc/NEWS.d/3.12.0a2.rst b/Misc/NEWS.d/3.12.0a2.rst index 117be21..d871384 100644 --- a/Misc/NEWS.d/3.12.0a2.rst +++ b/Misc/NEWS.d/3.12.0a2.rst @@ -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`. .. |