Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix erroneous backslashes in signatures and names #23658

Merged
merged 6 commits into from
Dec 17, 2020

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Dec 5, 2020

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.

Automerge-Triggered-By: GH:Mariatta

@andresdelfino andresdelfino requested a review from a team as a code owner December 6, 2020 20:26
@andresdelfino andresdelfino changed the title [doc] Fix signatures markup [doc] Fix signatures and attributes markup Dec 8, 2020
@andresdelfino andresdelfino changed the title [doc] Fix signatures and attributes markup [doc] Fix erroneous backslashes Dec 8, 2020
@andresdelfino andresdelfino changed the title [doc] Fix erroneous backslashes [doc] Fix erroneous backslashes in signatures and names Dec 8, 2020
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Thanks!

@miss-islington
Copy link
Contributor

Thanks @andresdelfino for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @andresdelfino, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker dcc997cd28ab33ebac44182ee55533c1b37689f7 3.9

@miss-islington miss-islington self-assigned this Dec 17, 2020
@miss-islington
Copy link
Contributor

Sorry @andresdelfino, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker dcc997cd28ab33ebac44182ee55533c1b37689f7 3.8

@andresdelfino andresdelfino deleted the fix_signatures branch December 17, 2020 01:39
@andresdelfino
Copy link
Contributor Author

I'll work on the backports tomorrow.

andresdelfino added a commit to andresdelfino/cpython that referenced this pull request Dec 17, 2020
…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 <adelfino@gmail.com>
@bedevere-bot
Copy link

GH-23827 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Dec 17, 2020
@bedevere-bot
Copy link

GH-23828 is a backport of this pull request to the 3.8 branch.

andresdelfino added a commit to andresdelfino/cpython that referenced this pull request Dec 17, 2020
…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 <adelfino@gmail.com>
miss-islington pushed a commit that referenced this pull request Dec 22, 2020
…) (GH-23827)

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 <adelfino@gmail.com>
miss-islington pushed a commit that referenced this pull request Dec 22, 2020
…) (GH-23828)

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 <adelfino@gmail.com>
JulienPalard added a commit that referenced this pull request Jan 4, 2021
…GH-23658)"

This partially reverts commit
e89993c, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
JulienPalard added a commit that referenced this pull request Jan 4, 2021
…GH-23658)"

This partially reverts commit
02349e2, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
JulienPalard added a commit that referenced this pull request Jan 4, 2021
…GH-23658)" (GH-24093)

This partially reverts commit
02349e2, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
JulienPalard added a commit that referenced this pull request Jan 4, 2021
…GH-23658)" (GH-24092)

This partially reverts commit
e89993c, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
JulienPalard added a commit to JulienPalard/cpython that referenced this pull request Jan 21, 2021
…onGH-23658)" (pythonGH-24093)

This partially reverts commit
02349e2, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants