Skip to content

gh-116281: Remove wrong '\' from '\*' in some doc signatures #116282

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 3, 2024
Merged

gh-116281: Remove wrong '\' from '\*' in some doc signatures #116282

merged 1 commit into from
Mar 3, 2024

Conversation

@HarryLHW
Copy link
Contributor

@HarryLHW HarryLHW commented Mar 3, 2024 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot mentioned this pull request Mar 3, 2024
Closed
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Mar 3, 2024
Privat33r-dev
Privat33r-dev approved these changes Mar 3, 2024
View reviewed changes
Copy link
Contributor

@Privat33r-dev Privat33r-dev left a comment

Choose a reason for hiding this comment

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

lgtm, thanks for the PR

@terryjreedy terryjreedy self-assigned this Mar 3, 2024
@terryjreedy terryjreedy added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Mar 3, 2024
@terryjreedy terryjreedy changed the title gh-116281: Some functions/methods include '\*' in the docs gh-116281: Remove wrong '\' from '\*' in some doc signatures Mar 3, 2024
@terryjreedy terryjreedy merged commit 4859ecb into python:main Mar 3, 2024
@miss-islington-app
Copy link

miss-islington-app bot commented Mar 3, 2024

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 3, 2024
@HarryLHW @miss-islington
pythongh-116281: Remove wrong '\' from '\*' in some doc signatures (p…
26d9f69 
…ythonGH-116282)

(cherry picked from commit 4859ecb)

Co-authored-by: HarryLHW <123lhw321@gmail.com>
@miss-islington-app
Copy link

miss-islington-app bot commented Mar 3, 2024

Sorry, @HarryLHW and @terryjreedy, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 4859ecb8609b51e2f6b8fb1b295e9ee0f83e1be6 3.11

@bedevere-app
Copy link

bedevere-app bot commented Mar 3, 2024

GH-116285 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 3, 2024
@terryjreedy
Copy link
Member

terryjreedy commented Mar 3, 2024

@ethanfurman 4 of the 6 bogus backslashes are yours in enum.rst. An isolated '*' in signatures does not need to be escaped from sphinx.

terryjreedy pushed a commit that referenced this pull request Mar 3, 2024
@miss-islington @HarryLHW
[3.12] gh-116281: Remove wrong '\' from '\*' in some doc signatures (G…
e95e837 
…H-116282) (#116285)

gh-116281: Remove wrong '\' from '\*' in some doc signatures (GH-116282)
(cherry picked from commit 4859ecb)

Co-authored-by: HarryLHW <123lhw321@gmail.com>
terryjreedy added a commit to terryjreedy/cpython that referenced this pull request Mar 3, 2024
@terryjreedy
pythongh-116281: Remove wrong '\' from '\*' in some doc signatures (p…
41df034 
…ython#116282)

(cherry picked from commit 4859ecb)

Co-authored-by: HarryLHW 123lhw321@gmail.com
@bedevere-app
Copy link

bedevere-app bot commented Mar 3, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Mar 3, 2024
terryjreedy added a commit that referenced this pull request Mar 3, 2024
@terryjreedy
[3.11] gh-116281: Remove wrong '\' from '\*' in some doc signatures (G…
7dfde84 
…H-116282) (#116289)

gh-116281: Remove wrong '\' from '\*' in some doc signatures (#116282)

(cherry picked from commit 4859ecb)

Co-authored-by: HarryLHW 123lhw321@gmail.com
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
@HarryLHW @woodruffw
pythongh-116281: Remove wrong '\' from '\*' in some doc signatures (p…
aec0fa3 
…ython#116282)
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024
@HarryLHW @adorilson
pythongh-116281: Remove wrong '\' from '\*' in some doc signatures (p…
a709ae7 
…ython#116282)
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
@HarryLHW @diegorusso
pythongh-116281: Remove wrong '\' from '\*' in some doc signatures (p…
3c26ea5 
…ython#116282)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ethanfurman ethanfurman Awaiting requested review from ethanfurman ethanfurman is a code owner

@gpshead gpshead Awaiting requested review from gpshead gpshead is a code owner

@tiran tiran Awaiting requested review from tiran

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

@kumaraditya303 kumaraditya303 Awaiting requested review from kumaraditya303 kumaraditya303 is a code owner

@willingc willingc Awaiting requested review from willingc willingc is a code owner

1 more reviewer

@Privat33r-dev Privat33r-dev Privat33r-dev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@terryjreedy terryjreedy

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@HarryLHW @terryjreedy @Privat33r-dev