Skip to content

Conversation

@ftnext
Copy link
Contributor

@ftnext ftnext commented Aug 28, 2023

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

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 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
@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
AlexWaygood pushed a commit that referenced this pull request Aug 28, 2023
…#108561)

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

Co-authored-by: nikkie <[email protected]>
Yhg1s pushed a commit that referenced this pull request Aug 28, 2023
…#108560)

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

Co-authored-by: nikkie <[email protected]>
@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

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