gh-97796: Special-case typing._AnnotatedAlias in pydoc.#97813
Closed
martindemello wants to merge 4 commits into
Closed
gh-97796: Special-case typing._AnnotatedAlias in pydoc.#97813martindemello wants to merge 4 commits into
martindemello wants to merge 4 commits into
Conversation
In general, pydoc.render_doc follows the `__origin__` property to render the doc for the pointed-to object, but in the case of `typing.Annotated[typ, ...]` we want the docs for `_AnnotatedAlias`, not `typ`.
sobolevn
reviewed
Oct 4, 2022
sobolevn
left a comment
sobolevn
left a comment
Member
There was a problem hiding this comment.
Thanks!
Can you please show how new help looks like for Annotated[str, 'meta'] and Annotated[str | int, 'meta']?
Contributor
Author
|
help for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In general, pydoc.render_doc follows the
__origin__property to render the doc for the pointed-to object, but in the case oftyping.Annotated[typ, ...]we want the docs for_AnnotatedAlias, nottyp.