[3.8] [doc] Fix erroneous backslashes in signatures and names (GH-23658) #23828
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andresdelfino
requested review from
1st1,
asvetlov,
gpshead and
a team
as code owners
bedevere-bot
added
skip issue
skip news
docs
…GH-23658) The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch). The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.. (cherry picked from commit dcc997c) Co-authored-by: Andre Delfino <[email protected]>
andresdelfino
force-pushed
the
backport-dcc997c-3.8
branch
from
cbf73a3 to
246dfee
Compare
|
@Mariatta perhaps we can merge this? |
|
As in the 3.8 and 3.9 branch we don't use the newer Sphinx, this commit drops the backslashes :( I think this should be reverted, are you ok for a revert @andresdelfino ? |
|
@JulienPalard this commit doesn't affect how the doc is rendered for 3.8/3.9, but I think it's good to have consistency with master (to prevent conflicts for future commits). |
|
@andresdelfino I just tried locally a first build on the top of 3.9, I have: and then reverted e89993c, build again, and I now have: so looks like e89993c made the backslash dissapear (see here in prod: https://docs.python.org/3.9/library/functions.html#print) |
|
@JulienPalard oh, yes, you are right; this should be reverted. Sorry! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did..
(cherry picked from commit dcc997c)
Co-authored-by: Andre Delfino [email protected]
Automerge-Triggered-By: GH:Mariatta