[Python-checkins] Remove misformatted exclamation marks in docs (#102694)
hugovk
webhook-mailer at python.org
Wed Mar 15 03:06:50 EDT 2023
https://github.com/python/cpython/commit/8647ba4b639077e201751ae6dbd82e8bfcf80895
commit: 8647ba4b639077e201751ae6dbd82e8bfcf80895
branch: main
author: Tom Levy <tomlevy93 at gmail.com>
committer: hugovk <hugovk at users.noreply.github.com>
date: 2023-03-15T09:06:32+02:00
summary:
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 at yahoo.co.uk>
files:
M Doc/library/venv.rst
M Misc/NEWS.d/3.12.0a2.rst
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 8eb0b35eaa12..240ab139838d 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 117be21a3221..d871384903e7 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`.
..
More information about the Python-checkins
mailing list