Remove misformatted exclamation marks in docs #102694
Conversation
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
|
All commit authors signed the Contributor License Agreement. |
|
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. |
There was a problem hiding this comment.
No ! before python, fish or csh 👍
https://deploy-preview-102694--python-cpython-preview.netlify.app/library/venv.html#how-venvs-work
|
Thanks for reviewing. I've signed the CLA.
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) |
|
We generally avoid force-pushing because PRs get squash merged anyway, so let's update with a regular commit. Thanks! |
|
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: |
|
I mixed up commit messages with the news file, which we don't have here :) I'll use that when merging, thanks again! |
|
Sorry, @tom93 and @hugovk, I could not cleanly backport this to |
|
Sorry @tom93 and @hugovk, I had trouble checking out the |
|
Sorry, @tom93 and @hugovk, I could not cleanly backport this to |
|
Sorry @tom93 and @hugovk, I had trouble checking out the |
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>
|
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>
|
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>
|
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>
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>
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