Skip to content

bpo-45655: Add "relevant PEPs" section to typing documentation #29280

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 4 commits into from
Oct 28, 2021
Merged

bpo-45655: Add "relevant PEPs" section to typing documentation #29280

merged 4 commits into from
Oct 28, 2021

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Oct 28, 2021 •
edited by bedevere-bot
Loading

The list of PEPs at the top of the documentation for the typing module has
become too long to be readable. This PR proposes presenting this
information in a more structured and readable way by adding a new "relevant
PEPs" section to the typing docs.

https://bugs.python.org/issue45655

@AlexWaygood
bpo-45655: Add "relevant PEPs" section to typing documentation
214cee9 
The list of PEPs at the top of the documentation for the ``typing`` module has
become too long to be readable. This PR proposes presenting this
information in a more structured and readable way by adding a new "relevant
PEPs" section to the ``typing`` docs.
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Oct 28, 2021
ambv
ambv reviewed Oct 28, 2021
View reviewed changes
@ambv ambv added needs backport to 3.10 only security fixes needs backport to 3.9 only security fixes labels Oct 28, 2021
@ambv
Copy link
Contributor

ambv commented Oct 28, 2021

We can backport to 3.9 but we need to modify the backport to remove 3.10 PEPs.

@ambv ambv merged commit 03db1bb into python:main Oct 28, 2021
@miss-islington
Copy link
Contributor

Thanks @AlexWaygood for the PR, and @ambv 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 Oct 28, 2021
@AlexWaygood @miss-islington
bpo-45655: Add "relevant PEPs" section to typing documentation (p…
ed836d7 
…ythonGH-29280)

The list of PEPs at the top of the documentation for the ``typing`` module has
become too long to be readable. This PR proposes presenting this
information in a more structured and readable way by adding a new "relevant
PEPs" section to the ``typing`` docs.

Co-authored-by: Łukasz Langa <[email protected]>
(cherry picked from commit 03db1bb)

Co-authored-by: Alex Waygood <[email protected]>
@miss-islington
Copy link
Contributor

Sorry, @AlexWaygood and @ambv, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 03db1bbfd2d3f5a343c293b2f0e09a1e962df7ea 3.9

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 28, 2021
@bedevere-bot
Copy link

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

@ambv
Copy link
Contributor

ambv commented Oct 28, 2021

@AlexWaygood, since the change is already conflicting, can you recreate it manually against 3.9?

@AlexWaygood
Copy link
Member Author

@AlexWaygood, since the change is already conflicting, can you recreate it manually against 3.9?

Sure, I'll have a go! (Thanks for the lightning speed in merging! 😀)

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Oct 28, 2021
@AlexWaygood
[3.9] bpo-45655: Add "relevant PEPs" section to typing documentation
7bd5b3d 
Backport of python#29280 to the 3.9 branch.
@AlexWaygood AlexWaygood mentioned this pull request Oct 28, 2021
Merged
@AlexWaygood
Copy link
Member Author

@AlexWaygood, since the change is already conflicting, can you recreate it manually against 3.9?

3.9 backport here #29297 😊

ambv pushed a commit that referenced this pull request Oct 28, 2021
@AlexWaygood
[3.9] bpo-45655: Add "relevant PEPs" section to typing documentation (G…
8813a98 
…H-29297)

Backport of #29280 to the 3.9 branch.
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Oct 28, 2021
@AlexWaygood
[3.10] bpo-45655: Add "relevant PEPs" section to typing documenta…
33ab63e 
…tion

Backport of python#29280 to the 3.10 branch.
@AlexWaygood AlexWaygood mentioned this pull request Oct 28, 2021
Merged
@AlexWaygood
Copy link
Member Author

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

This backport has been closed in favour of #29302, which is a new backport to the 3.10 branch

@AlexWaygood AlexWaygood deleted the typing-docs branch October 29, 2021 10:22
@ambv ambv removed the needs backport to 3.9 only security fixes label Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ambv ambv ambv left review comments

@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees

@ambv ambv

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AlexWaygood @ambv @miss-islington @bedevere-bot @the-knights-who-say-ni