Skip to content

[3.10] Remove misformatted exclamation marks in docs (GH-102694) #102717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 1 commit into from
Mar 15, 2023
Merged

[3.10] Remove misformatted exclamation marks in docs (GH-102694) #102717

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
[3.10] Remove misformatted exclamation marks in docs (GH-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 GH-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 @hugovk
tom93 authored and hugovk committed Mar 15, 2023
commit 21691b0d094bdf303e5665049e7736f5ef4794b7
4 changes: 2 additions & 2 deletions Doc/library/venv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down