[issue40979] typing module docs: keep text, add subsections

Guido van Rossum added the comment: New changeset b3ad2ca56afc6a56c9a6e7b419bc05e8e5b15e19 by Guido van Rossum in branch '3.9': [3.9] bpo-40979: refactored typing.rst; (mostly) same content, new sub-sections and ordering (GH-21574) (#21843)

[issue40979] typing module docs: keep text, add subsections

Change by Guido van Rossum : -- pull_requests: +20970 pull_request: https://github.com/python/cpython/pull/21843 ___ Python tracker ___

[issue40979] typing module docs: keep text, add subsections

Guido van Rossum added the comment: Thank you so much for your hard work and flexibility! The chapter is in much better shape now. -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker

[issue40979] typing module docs: keep text, add subsections

Guido van Rossum added the comment: New changeset ab72fdeb82c3ab045b480cd4bb4f928c12653ecb by Luciano Ramalho in branch 'master': bpo-40979: refactored typing.rst; (mostly) same content, new sub-sections and ordering (#21574)

[issue40979] typing module docs: keep text, add subsections

Luciano Ramalho added the comment: I have incorporated Guido's suggestions and added additional subsections to make it easier to navigate the page. I also added notes that fix the issue https://bugs.python.org/issue40978 — "Document that typing.SupportsXXX protocols are runtime checkable"

[issue40979] typing module docs: keep text, add subsections

Ivan Levkivskyi added the comment: FWIW I like Guido's suggestion in the PR, I would rather use "importance order" than alphabetical order. -- ___ Python tracker ___

[issue40979] typing module docs: keep text, add subsections

Raymond Hettinger added the comment: This organization makes good sense to me. Hopefully, we can get Guido and Ivan to take a look at it. -- nosy: +gvanrossum, levkivskyi ___ Python tracker

[issue40979] typing module docs: keep text, add subsections

Luciano Ramalho added the comment: Reviewers, besides adding section titles and reordering the entries, I made only these changes to the text: - entry for IO, TextIO, BinaryIO: added sentence "These types are in the ``typing.io`` namespace." - entry for Pattern, Match: added sentence

[issue40979] typing module docs: keep text, add subsections

Change by Roundup Robot : -- keywords: +patch nosy: +python-dev nosy_count: 3.0 -> 4.0 pull_requests: +20717 stage: -> patch review pull_request: https://github.com/python/cpython/pull/21574 ___ Python tracker

[issue40979] typing module docs: keep text, add subsections

ramalho added the comment: This is my proposal for sections to replace the existing "Classes, functions, and decorators" section. The names are sorted within each section. # Special typing primitives Any Callable ClassVar ForwardRef Generic

[issue40979] typing module docs: keep text, add subsections

ramalho added the comment: Sorry, there was an editing mistake above. Where I wrote: - AnyStr: should be listed right after TypeVar, NoReturn, NewType I meant to write: - AnyStr: should be listed right after TypeVar - NoReturn, NewType: both belong with "Special Constructs" as well -

[issue40979] typing module docs: keep text, add subsections

ramalho added the comment: Thanks, I am happy to submit a PR. Before I do, I'd like to discuss the subsection titles, starting from the arrangement in typing.__all__: # Special typing constructs (source comment is: "Super-special typing primitives") Any Callable ClassVar Final ForwardRef

[issue40979] typing module docs: keep text, add subsections

Raymond Hettinger added the comment: Would you care to submit a PR? -- nosy: +rhettinger ___ Python tracker ___ ___

[issue40979] typing module docs: keep text, add subsections

New submission from ramalho : The typing module documentation page has a very long section "Classes, functions, and decorators" (https://docs.python.org/3/library/typing.html#classes-functions-and-decorators) that should be split in subsections. The ordering of the entries seems haphazard: