Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-06 15:32:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Remove misformatted exclamation marks in docs (#102694)

Browse source 
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>
This commit is contained in:
Tom Levy 2023-03-15 20:06:32 +13:00 • committed by GitHub
parent 5e0865f22e
commit 8647ba4b63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/library/venv.rst
View file

@ -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

2
Misc/NEWS.d/3.12.0a2.rst
View file

@ -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`.
..