Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Remove misformatted exclamation marks in docs#102694

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.

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

Already on GitHub?Sign in to your account

Merged
hugovk merged 1 commit intopython:mainfromtom93:fix-rst-program-excl-mark
Mar 15, 2023
Merged

Remove misformatted exclamation marks in docs#102694

hugovk merged 1 commit intopython:mainfromtom93:fix-rst-program-excl-mark
Mar 15, 2023

Conversation

@tom93
Copy link
Contributor

@tom93tom93 commentedMar 14, 2023•
edited
Loading

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 becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[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
@tom93tom93 requested a review fromvsajip as acode ownerMarch 14, 2023 13:51
@bedevere-botbedevere-bot added docsDocumentation in the Doc dir skip news awaiting review labelsMar 14, 2023
@ghost
Copy link

ghost commentedMar 14, 2023•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@hugovk
Copy link
Member

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.

@hugovkhugovk added needs backport to 3.10only security fixes needs backport to 3.11only security fixes labelsMar 14, 2023
Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@tom93
Copy link
ContributorAuthor

tom93 commentedMar 15, 2023•
edited
Loading

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 fromthis tothis? (branch fix-rst-program-excl-mark-v2)

@hugovk
Copy link
Member

hugovk commentedMar 15, 2023•
edited
Loading

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

@tom93
Copy link
ContributorAuthor

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 becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced in #98350. Seecomments [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-1286394047Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>

@hugovk
Copy link
Member

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

I'll use that when merging, thanks again!

tom93 reacted with thumbs up emoji

@hugovkhugovk merged commit8647ba4 intopython:mainMar 15, 2023
@miss-islington
Copy link
Contributor

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
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

@hugovkhugovk added needs backport to 3.10only security fixes needs backport to 3.11only security fixes and removed needs backport to 3.11only security fixes needs backport to 3.10only security fixes labelsMar 15, 2023
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

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

hugovk pushed a commit to hugovk/cpython that referenced this pull requestMar 15, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpython#98350. Seecomments [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 commit8647ba4)
hugovk added a commit to hugovk/cpython that referenced this pull requestMar 15, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpythonGH-98350. Seecomments [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-1286394047Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>.(cherry picked from commit8647ba4)Co-authored-by: Tom Levy <tomlevy93@gmail.com>
@tom93
Copy link
ContributorAuthor

tom93 commentedMar 15, 2023•
edited
Loading

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).

hugovk reacted with thumbs up emoji

hugovk pushed a commit to hugovk/cpython that referenced this pull requestMar 15, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpythonGH-98350. Seecomments [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-1286394047Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>.(cherry picked from commit8647ba4)Co-authored-by: Tom Levy <tomlevy93@gmail.com>
@bedevere-bot
Copy link

GH-102716 is a backport of this pull request to the3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelMar 15, 2023
hugovk pushed a commit to hugovk/cpython that referenced this pull requestMar 15, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpythonGH-98350. Seecomments [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-1286394047Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>.(cherry picked from commit8647ba4)Co-authored-by: Tom Levy <tomlevy93@gmail.com>
@bedevere-bot
Copy link

GH-102717 is a backport of this pull request to the3.10 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.10only security fixes labelMar 15, 2023
hugovk added a commit that referenced this pull requestMar 15, 2023
…2716)Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced in#98350. Seecomments [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>
hugovk added a commit that referenced this pull requestMar 15, 2023
…2717)Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced in#98350. Seecomments [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>
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this pull requestMar 27, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpython#98350. Seecomments [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>
warsaw pushed a commit to warsaw/cpython that referenced this pull requestApr 11, 2023
Remove the exclamation mark from :program:`!foo` in .rst files becauseit inadvertently shows up in the rendered HTML.(Sphinx's cross-referencing roles use a '!' prefix to suppresshyperlinking[1], but :program: is not a cross-referencing role so the'!' is displayed verbatim.)The exclamation marks in venv.rst were introduced inpython#98350. Seecomments [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>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

@vsajipvsajipAwaiting requested review from vsajipvsajip is a code owner

Assignees

@hugovkhugovk

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@tom93@hugovk@miss-islington@bedevere-bot
[8]ページ先頭
©2009-2025 Movatter.jp