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

typing.Annotated should document the __metadata__ field #97797

Closed
martindemello opened this issue Oct 3, 2022 · 1 comment
Closed

typing.Annotated should document the __metadata__ field #97797

martindemello opened this issue Oct 3, 2022 · 1 comment
Assignees
@sobolevn
Labels
docs Documentation in the Doc dir topic-typing

Comments

@martindemello
Copy link
Contributor

martindemello commented Oct 3, 2022 •
edited by bedevere-bot

Both help(typing.Annotated) and help(typing._AnnotatedAlias) should document the __metadata__ field; based on the comments in #89543 the field was meant to be public but was inadvertently omitted from the PEP and documentation.

Linked PRs
@martindemello martindemello added the docs Documentation in the Doc dir label Oct 3, 2022
@AlexWaygood AlexWaygood mentioned this issue Apr 9, 2023
Merged
@sobolevn sobolevn self-assigned this Apr 10, 2023
sobolevn added a commit to sobolevn/cpython that referenced this issue Apr 10, 2023
@sobolevn
pythongh-97797: Mention __metadata__ in docstrings of `typing.{_Ann…
9010696 
…otatedAlias, Annotated}`
This was referenced Apr 10, 2023
Merged
Merged
AlexWaygood added a commit that referenced this issue Apr 10, 2023
@sobolevn @AlexWaygood @Eclips4
gh-97797: Mention __metadata__ in docstrings of `typing.{_Annotated…
dc604a8 
…Alias, Annotated}` (#103405)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 10, 2023
@sobolevn @AlexWaygood
@Eclips4 @miss-islington
pythongh-97797: Mention __metadata__ in docstrings of `typing.{_Ann…
90916c4 
…otatedAlias, Annotated}` (pythonGH-103405)

(cherry picked from commit dc604a8)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
miss-islington added a commit that referenced this issue Apr 10, 2023
@miss-islington @sobolevn
@AlexWaygood @Eclips4
gh-97797: Mention __metadata__ in docstrings of `typing.{_Annotated…
0f6319f 
…Alias, Annotated}` (GH-103405)

(cherry picked from commit dc604a8)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
@sobolevn @AlexWaygood
@Eclips4 @warsaw
pythongh-97797: Mention __metadata__ in docstrings of `typing.{_Ann…
fee8857 
…otatedAlias, Annotated}` (python#103405)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this issue Apr 18, 2023
@sobolevn @AlexWaygood
@Eclips4 @aisk
pythongh-97797: Mention __metadata__ in docstrings of `typing.{_Ann…
fe36c64 
…otatedAlias, Annotated}` (python#103405)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Jun 6, 2023
@AlexWaygood
pythongh-97797: Improve documentation for typing.Annotated
6eba81f
@bedevere-bot bedevere-bot mentioned this issue Jun 6, 2023
Merged
JelleZijlstra pushed a commit that referenced this issue Jun 7, 2023
@AlexWaygood
gh-97797: Improve documentation for typing.Annotated (#105365)
e26d296
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 7, 2023
@AlexWaygood @miss-islington
pythongh-97797: Improve documentation for typing.Annotated (pythonGH-…
7a6ca12 
…105365)

(cherry picked from commit e26d296)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Jun 7, 2023
Merged
JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this issue Jun 7, 2023
@AlexWaygood @JelleZijlstra
[3.11] pythongh-97797: Improve documentation for typing.Annotated (py…
d7dd378 
…thonGH-105365).

(cherry picked from commit e26d296)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Jun 7, 2023
Merged
AlexWaygood added a commit that referenced this issue Jun 7, 2023
@miss-islington @AlexWaygood
[3.12] gh-97797: Improve documentation for typing.Annotated (GH-105365)…
241c36e 
… (#105448)

gh-97797: Improve documentation for typing.Annotated (GH-105365)
(cherry picked from commit e26d296)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
JelleZijlstra added a commit that referenced this issue Jun 7, 2023
@JelleZijlstra @AlexWaygood
[3.11] gh-97797: Improve documentation for typing.Annotated (GH-105365)…
d0af527 
…. (#105449)

(cherry picked from commit e26d296)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Copy link
Member

Now documented in the docstring and in typing.rst

@AlexWaygood AlexWaygood mentioned this issue Jun 7, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sobolevn sobolevn

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

No branches or pull requests
4 participants
@martindemello @gvanrossum @sobolevn @AlexWaygood