Remove misformatted exclamation marks in docs#102694

tom93 · 2023-03-14T13:51:48Z

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 #98350 (comment) and #98350 (comment) for additional discussion.

[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax

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 #98465. [1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax

ghost · 2023-03-14T13:52:15Z

All commit authors signed the Contributor License Agreement.

hugovk · 2023-03-14T21:32:43Z

Thanks for spotting this, it was noted at #98350 (comment) post-merge and was to be fixed but I guess it dropped off the todo lists.

@tom93 This PR is possibly trivial enough to merge without the CLA, but if you're okay signing it that would be much quicker and easier.

hugovk

No ! before python, fish or csh 👍

https://deploy-preview-102694--python-cpython-preview.netlify.app/library/venv.html#how-venvs-work

tom93 · 2023-03-15T06:40:41Z

Thanks for reviewing. I've signed the CLA.

it was noted at #98350 (comment) post-merge and was to be fixed but I guess it dropped off the todo lists.

I missed that (was looking at the wrong PR). Is it okay if I force-push to change the commit message from this to this? (branch fix-rst-program-excl-mark-v2)

hugovk · 2023-03-15T06:53:47Z

We generally avoid force-pushing because PRs get squash merged anyway, so let's update with a regular commit. Thanks!

tom93 · 2023-03-15T07:00:31Z

I'm not sure how to update the commit message using a second commit, but it's no big deal -- feel free to merge as-is. Or if you have a chance to set the commit message when merging, here is my proposed message:

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>

hugovk · 2023-03-15T07:06:09Z

I mixed up commit messages with the news file, which we don't have here :)

I'll use that when merging, thanks again!

miss-islington · 2023-03-15T07:06:36Z

Thanks @tom93 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington · 2023-03-15T07:06:41Z

Sorry, @tom93 and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 8647ba4b639077e201751ae6dbd82e8bfcf80895 3.11

miss-islington · 2023-03-15T07:06:44Z

Sorry @tom93 and @hugovk, I had trouble checking out the 3.10 backport branch.
Please retry by removing and re-adding the "needs backport to 3.10" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 8647ba4b639077e201751ae6dbd82e8bfcf80895 3.10

miss-islington · 2023-03-15T07:08:26Z

Thanks @tom93 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington · 2023-03-15T07:08:26Z

Thanks @tom93 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington · 2023-03-15T07:08:28Z

Sorry, @tom93 and @hugovk, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 8647ba4b639077e201751ae6dbd82e8bfcf80895 3.10

miss-islington · 2023-03-15T07:08:30Z

Sorry @tom93 and @hugovk, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 8647ba4b639077e201751ae6dbd82e8bfcf80895 3.11

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 python#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]: python#98350 (comment) [3]: python#98350 (comment) Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> (cherry picked from commit 8647ba4)

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

tom93 · 2023-03-15T07:10:43Z

Thanks for merging! The backport issue is probably because my commit also removes a '!' from Misc/NEWS.d/3.12.0a2.rst (which doesn't exist in 3.10/3.11).

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

bedevere-bot · 2023-03-15T07:13:45Z

GH-102716 is a backport of this pull request to the 3.11 branch.

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

bedevere-bot · 2023-03-15T07:15:22Z

GH-102717 is a backport of this pull request to the 3.10 branch.

…2716) 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]: #98350 (comment) [3]: #98350 (comment) Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Tom Levy <tomlevy93@gmail.com>

…2717) 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]: #98350 (comment) [3]: #98350 (comment) Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Tom Levy <tomlevy93@gmail.com>

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 python#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]: python#98350 (comment) [3]: python#98350 (comment) Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>

tom93 requested a review from vsajip as a code owner March 14, 2023 13:51

bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 14, 2023

hugovk added the skip issue label Mar 14, 2023

hugovk added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Mar 14, 2023

hugovk approved these changes Mar 14, 2023
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Mar 14, 2023

hugovk merged commit 8647ba4 into python:mainMar 15, 2023

bedevere-bot removed the awaiting merge label Mar 15, 2023

miss-islington assigned hugovk Mar 15, 2023

hugovk added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes needs backport to 3.10 only security fixes labels Mar 15, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label Mar 15, 2023

bedevere-bot removed the needs backport to 3.10 only security fixes label Mar 15, 2023

tom93 mentioned this pull request Mar 15, 2023
[doc] Refresh the venv introduction documentation, and correct the statement about VIRTUAL_ENV (GH-98350) #98350
Merged

Uh oh!

Remove misformatted exclamation marks in docs#102694

Remove misformatted exclamation marks in docs #102694

Uh oh!

Conversation

tom93 commented Mar 14, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Mar 14, 2023• edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Mar 14, 2023

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

tom93 commented Mar 15, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Mar 15, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tom93 commented Mar 15, 2023

Uh oh!

hugovk commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

miss-islington commented Mar 15, 2023

Uh oh!

tom93 commented Mar 15, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-bot commented Mar 15, 2023

Uh oh!

bedevere-bot commented Mar 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tom93 commented Mar 14, 2023•
edited
Loading

ghost commented Mar 14, 2023•
edited by ghost
Loading

tom93 commented Mar 15, 2023•
edited
Loading

hugovk commented Mar 15, 2023•
edited
Loading

tom93 commented Mar 15, 2023•
edited
Loading