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.

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

bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs #30148

Merged
merged 6 commits into from Dec 18, 2021
Merged

bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs #30148

merged 6 commits into from Dec 18, 2021

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 16, 2021 •
edited by bedevere-bot

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Dec 16, 2021
@AlexWaygood AlexWaygood added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes skip news type-feature A feature request or enhancement labels Dec 16, 2021
sobolevn
sobolevn reviewed Dec 16, 2021
View reviewed changes
Doc/library/typing.rst Outdated Show resolved Hide resolved
sobolevn
sobolevn approved these changes Dec 16, 2021
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

The second version solves my concern! Thank you! 👍

@AlexWaygood
Copy link
Member Author

The second version solves my concern! Thank you! 👍

Thanks for taking the time to review! 😀

asvetlov
asvetlov reviewed Dec 17, 2021
View reviewed changes
Doc/library/typing.rst Outdated Show resolved Hide resolved
asvetlov
asvetlov reviewed Dec 17, 2021
View reviewed changes
Copy link
Contributor

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

I believe single quotes help to emphasize variable names

Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
AlexWaygood and others added 3 commits December 17, 2021 10:07
@AlexWaygood @asvetlov
Update Doc/library/typing.rst
4ae6e8f 
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
@AlexWaygood @asvetlov
Update Doc/library/typing.rst
0b7e1b1 
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
@AlexWaygood @asvetlov
Update Doc/library/typing.rst
65073f0 
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
asvetlov
asvetlov approved these changes Dec 17, 2021
View reviewed changes
Copy link
Contributor

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

LGTM.
Let's wait for a day, please ping me tomorrow

@Fidget-Spinner Fidget-Spinner merged commit 6ada013 into python:main Dec 18, 2021
@miss-islington
Copy link
Contributor

Thanks @AlexWaygood for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 18, 2021
@AlexWaygood @miss-islington
bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (pythonGH-…
beda545 
…30148)

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Dec 18, 2021
@bedevere-bot
Copy link

GH-30179 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 18, 2021
@AlexWaygood @miss-islington
bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (pythonGH-…
a07abaf 
…30148)

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot
Copy link

GH-30180 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 18, 2021
@AlexWaygood AlexWaygood deleted the typing-docs-comments branch December 18, 2021 11:50
miss-islington added a commit that referenced this pull request Dec 18, 2021
@miss-islington @AlexWaygood
[3.9] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-…
43cb8f4 
…30148) (GH-30180)

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington added a commit that referenced this pull request Dec 18, 2021
@miss-islington @AlexWaygood
[3.10] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH…
a66be91 
…-30148) (GH-30179)

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood AlexWaygood mentioned this pull request Dec 18, 2021
Merged
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 19, 2021
@AlexWaygood
bpo-46104: Fix example broken by pythonGH-30148
cfdd9d4 
This PR addresses a review by @gvanrossum, which can be found in the discussion in pythonGH-30179.
Fidget-Spinner pushed a commit that referenced this pull request Dec 20, 2021
@AlexWaygood
bpo-46104: Fix example broken by GH-30148 (GH-30203)
7c5c3f7 
See discussion in GH-30179.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 20, 2021
@AlexWaygood @miss-islington
bpo-46104: Fix example broken by pythonGH-30148 (pythonGH-30203)
c49e819 
See discussion in pythonGH-30179.
(cherry picked from commit 7c5c3f7)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 20, 2021
@AlexWaygood @miss-islington
bpo-46104: Fix example broken by pythonGH-30148 (pythonGH-30203)
0b7f9ac 
See discussion in pythonGH-30179.
(cherry picked from commit 7c5c3f7)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington added a commit that referenced this pull request Dec 20, 2021
@miss-islington
[3.10] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30209)
0c0bd78 
See discussion in GH-30179.
(cherry picked from commit 7c5c3f7)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:Fidget-Spinner
miss-islington added a commit that referenced this pull request Dec 20, 2021
@miss-islington
[3.9] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30210)
8e4564d 
See discussion in GH-30179.
(cherry picked from commit 7c5c3f7)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:Fidget-Spinner
brandtbucher pushed a commit to brandtbucher/cpython that referenced this pull request Dec 27, 2021
@AlexWaygood @brandtbucher
bpo-46104: Fix example broken by pythonGH-30148 (pythonGH-30203)
25ad960 
See discussion in pythonGH-30179.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asvetlov asvetlov asvetlov approved these changes

@sobolevn sobolevn sobolevn approved these changes

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

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@AlexWaygood @miss-islington @bedevere-bot @asvetlov @sobolevn @Fidget-Spinner @the-knights-who-say-ni