[issue42198] Clean up docs for Union and GenericAlias
New submission from Ken Jin <kenjin4096@gmail.com>: This is an umbrella issue to clean up docs for Union and GenericAlias. To-do (not in order): 1. Update links in typing, subscription and union to point to GenericAlias. 2. Park GenericAlias and Union under a new section 'Type Annotation Types' in stdtypes for 3.10. The reason is to follow with the rest of the stdtypes' doc convention. 3. Consistency nitpicks for Union's docs. ---------- assignee: docs@python components: Documentation messages: 379876 nosy: docs@python, gvanrossum, kj priority: normal severity: normal status: open title: Clean up docs for Union and GenericAlias versions: Python 3.10, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by Ken Jin <kenjin4096@gmail.com>: ---------- keywords: +patch pull_requests: +21948 stage: -> patch review pull_request: https://github.com/python/cpython/pull/23029 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Ken Jin <kenjin4096@gmail.com> added the comment: 4. types.GenericAlias's __call__ signature of (origin, args) is not documented anywhere, I'll create a PR to types.rst eventually. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by Ken Jin <kenjin4096@gmail.com>: ---------- pull_requests: +21949 pull_request: https://github.com/python/cpython/pull/23030 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 9129af6050b747f288baa9d4e7d43031647ed222 by kj in branch 'master': bpo-42198: Link to GenericAlias in typing and expressions (GH-23030) https://github.com/python/cpython/commit/9129af6050b747f288baa9d4e7d43031647... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +21952 pull_request: https://github.com/python/cpython/pull/23033 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset a39068bf48766e5520e175eae8cda33531e16039 by Miss Skeleton (bot) in branch '3.9': bpo-42198: Link to GenericAlias in typing and expressions (GH-23030) https://github.com/python/cpython/commit/a39068bf48766e5520e175eae8cda33531e... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by Ken Jin <kenjin4096@gmail.com>: ---------- pull_requests: +21958 pull_request: https://github.com/python/cpython/pull/23039 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset bcbf758476c1148993ddf4b54d3f6169b973ee1c by kj in branch 'master': bpo-42198: Document __new__ for types.GenericAlias (GH-23039) https://github.com/python/cpython/commit/bcbf758476c1148993ddf4b54d3f6169b97... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by Ken Jin <kenjin4096@gmail.com>: ---------- pull_requests: +21980 pull_request: https://github.com/python/cpython/pull/23061 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset dbaa07db671c4e5842629c8be912f2b0370be794 by kj in branch '3.9': [3.9] bpo-42198: Document __new__ for types.GenericAlias (GH-23039) (GH-23061) https://github.com/python/cpython/commit/dbaa07db671c4e5842629c8be912f2b0370... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset d21cb2d5ee56b8975d92e2ee094aba81f0801be5 by kj in branch 'master': bpo-42198: Improve consistency of Union docs (GH-23029) https://github.com/python/cpython/commit/d21cb2d5ee56b8975d92e2ee094aba81f08... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Guido van Rossum <guido@python.org> added the comment: Thanks for all your efforts, KJ! Can this issue be closed? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Ken Jin <kenjin4096@gmail.com> added the comment: Guido, I have one last one -- "2. Park GenericAlias and Union under a new section 'Type Annotation Types' in stdtypes for 3.10". After which I'll close this issue. Thanks for reviewing my PRs so quickly! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Change by Ken Jin <kenjin4096@gmail.com>: ---------- pull_requests: +21982 pull_request: https://github.com/python/cpython/pull/23063 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Guido van Rossum <guido@python.org> added the comment: New changeset 3bf0d02f2817c48b6ee61a95b52a6d76ad543be9 by kj in branch 'master': bpo-42198: New section in stdtypes for type annotation types (GH-23063) https://github.com/python/cpython/commit/3bf0d02f2817c48b6ee61a95b52a6d76ad5... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
Guido van Rossum <guido@python.org> added the comment: Thanks Ken Ji for all your help! I'll close this now. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________
participants (3)
-
Guido van Rossum -
Ken Jin
-
miss-islington