8000 fixing a typo in docs: Remove redundant back quote by ftnext · Pull Request #108559 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

fixing a typo in docs: Remove redundant back quote #108559

8000
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
Aug 28, 2023
Merged

fixing a typo in docs: Remove redundant back quote #108559

merged 1 commit into from
Aug 28, 2023

Conversation

ftnext
Copy link
Contributor
@ftnext ftnext commented Aug 28, 2023 •
edited by github-actions bot
Loading

I noticed a trivial change while reading the typing module's documentation.

Writers use double back quotes in the code comments to show the type.
example:

``tuple``

I noticed there are triple back quotes.
https://docs.python.org/3/library/typing.html#the-type-of-class-objects

a = 3         # Has type ``int```

I believe we should enclose with two back quotes for a consistent style throughout the document.

📚 Documentation preview 📚: https://cpython-previews--108559.org.readthedocs.build/

@ghost
Copy link
ghost commented Aug 28, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Aug 28, 2023
@AlexWaygood AlexWaygood enabled auto-merge (squash) August 28, 2023 11:17
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes 8000 needs backport to 3.12 only security fixes labels Aug 28, 2023
@AlexWaygood AlexWaygood merged commit 72b615a into python:main Aug 28, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 28, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 28, 2023
@ftnext @miss-islington
Fix typo in typing docs: Remove redundant backtick (pythonGH-108559)
ebc6d9f 
(cherry picked from commit 72b615a)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 28, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 28, 2023
@ftnext @miss-islington
Fix typo in typing docs: Remove redundant backtick (pythonGH-108559)
8244f0d 
(cherry picked from commit 72b615a)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
AlexWaygood pushed a commit that referenced this pull request Aug 28, 2023
@miss-islington @ftnext
[3.11] Fix typo in typing docs: Remove redundant backtick (GH-108559) (…
c19713d 
…#108561)

Fix typo in typing docs: Remove redundant backtick (GH-108559)
(cherry picked from commit 72b615a)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
Yhg1s pushed a commit that referenced this pull request Aug 28, 2023
@miss-islington @ftnext
[3.12] Fix typo in typing docs: Remove redundant backtick (GH-108559) (…
5531d03 
…#108560)

Fix typo in typing docs: Remove redundant backtick (GH-108559)
(cherry picked from commit 72b615a)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
@ftnext ftnext deleted the tweak-typing-docs-back-quote branch March 11, 2024 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

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

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ftnext @miss-islington @bedevere-bot @Fidget-Spinner @AlexWaygood
0