Skip to content

More reorganisation of the typing docs #105787

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
Jun 15, 2023
Merged

More reorganisation of the typing docs #105787

merged 1 commit into from
Jun 15, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Jun 14, 2023 •
edited by github-actions bot
Loading

  1. Merge the "Generic Concrete Collections" and "Abstract Base classes" sections into a "Deprecated Aliases" section. Rename that section and the subsections inside it to better reflect the fact that all items within the "Deprecated aliases" section are deprecated. Add anchors so that the old links will still work, if people are linking to subsections from external sites.
  2. Move the "async-ABC aliases" section above the "misc-ABC aliases" section. "Aliases to container ABCs from collections.abc; aliases to async ABCs from collections.abc; and aliases to other ABCs from collections.abc" reads more naturally than "Aliases to container ABCs from collections.abc; aliases to other ABCs from collections.abc; and aliases to async ABCs from collections.abc".
  3. Move typing.IO, typing.TextIO and typing.BinaryIO to their own section. They are currently the only items in the "Generic concrete collections" and "Abstract Base Classes" sections that aren't deprecated.

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

@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jun 14, 2023
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jun 14, 2023
CAM-Gerlach
CAM-Gerlach approved these changes Jun 14, 2023
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM from a docs perspective 👍

@AlexWaygood AlexWaygood merged commit da911a6 into python:main Jun 15, 2023
@miss-islington
Copy link
Contributor

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

@AlexWaygood AlexWaygood deleted the typing-docs-reorg branch June 15, 2023 05:52
@miss-islington
Copy link
Contributor

Sorry @AlexWaygood, I had trouble checking out the 3.12 backport branch.
Please retry by removing and re-adding the "needs backport to 3.12" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker da911a6b226ca47cc15088d800b575e19a731f1c 3.12

@miss-islington
Copy link
Contributor

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

@AlexWaygood AlexWaygood added needs backport to 3.12 only security fixes and removed needs backport to 3.12 only security fixes labels Jun 15, 2023
@miss-islington
Copy link
Contributor

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @AlexWaygood, I had trouble checking out the 3.12 backport branch.
Please retry by removing and re-adding the "needs backport to 3.12" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker da911a6b226ca47cc15088d800b575e19a731f1c 3.12

@AlexWaygood AlexWaygood added needs backport to 3.12 only security fixes and removed needs backport to 3.12 only security fixes labels Jun 15, 2023
@miss-islington
Copy link
Contributor

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 15, 2023
@AlexWaygood @miss-islington
More reorganisation of the typing docs (pythonGH-105787)
56d9366 
(cherry picked from commit da911a6)

Co-authored-by: Alex Waygood <[email protected]>
@bedevere-bot
Copy link

GH-105810 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 Jun 15, 2023
AlexWaygood added a commit that referenced this pull request Jun 15, 2023
@miss-islington @AlexWaygood
[3.12] More reorganisation of the typing docs (GH-105787) (#105810)
9012c55 
More reorganisation of the typing docs (GH-105787)
(cherry picked from commit da911a6)

Co-authored-by: Alex Waygood <[email protected]>
@AlexWaygood AlexWaygood mentioned this pull request Jun 15, 2023
Merged
@bedevere-bot
Copy link

GH-105816 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 Jun 15, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Jun 15, 2023
@AlexWaygood
[3.11] More reorganisation of the typing docs (python#105787)
67644e9
AlexWaygood added a commit that referenced this pull request Jun 15, 2023
@AlexWaygood
[3.11] More reorganisation of the typing docs (#105787) (#105816)
6be46c3
carljm added a commit to carljm/cpython that referenced this pull request Jun 15, 2023
@carljm
Merge branch 'main' into modulelocals
166aca9 
* main: (57 commits)
  pythongh-105831: Fix NEWS blurb from pythongh-105828 (python#105833)
  pythongh-105820: Fix tok_mode expression buffer in file & readline tokenizer (python#105828)
  pythongh-105751, test_ctypes: Remove disabled tests (python#105826)
  pythongh-105821: Use a raw f-string in test_httpservers.py (python#105822)
  pythongh-105751: Remove platform usage in test_ctypes (python#105819)
  pythongh-105751: Reenable disable test_ctypes tests (python#105818)
  pythongh-105751: Remove dead code in test_ctypes (python#105817)
  More reorganisation of the typing docs (python#105787)
  Improve docs for `typing.dataclass_transform` (python#105792)
  pythonGH-89812: Churn `pathlib.Path` test methods (python#105807)
  pythongh-105800: Issue SyntaxWarning in f-strings for invalid escape sequences (python#105801)
  pythongh-105751: Cleanup test_ctypes imports (python#105803)
  pythongh-105481: add HAS_JUMP flag to opcode metadata (python#105791)
  pythongh-105751: test_ctypes avoids the operator module (pythonGH-105797)
  pythongh-105751: test_ctypes: Remove @need_symbol decorator (pythonGH-105798)
  pythongh-104909: Implement conditional stack effects for macros (python#105748)
  pythongh-75905: Remove test_xmlrpc_net: skipped since 2017 (python#105796)
  pythongh-105481: Fix types and a bug for pseudos (python#105788)
  Update DSL docs for cases generator (python#105753)
  pythonGH-77273: Better bytecodes for f-strings (pythonGH-6132)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

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

Assignees

@AlexWaygood AlexWaygood

Labels
docs Documentation in the Doc dir skip issue skip news topic-typing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AlexWaygood @miss-islington @bedevere-bot @JelleZijlstra @CAM-Gerlach