Fix #8460: autodoc: Support custom types defined by typing.NewType #8465
Conversation
This file contains 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
tk0miya
added
type:enhancement
tk0miya
force-pushed
the
8460_NewType
branch
from
36ed7ec
to
b1d5081
Compare
tk0miya
commented
Nov 21, 2020
tk0miya
force-pushed
the
8460_NewType
branch
from
b1d5081
to
0b508a0
Compare
tk0miya
commented
Nov 21, 2020
tk0miya
commented
Nov 21, 2020
…NewType A custom type defined by typing.NewType was rendered as a function because the generated type is a function having special attributes. This renders it as a variable. Note: The module name where the NewType object defined is lost on generating it. So it is hard to make cross-reference for these custom types.
Separate NewType feature from DataDocumenter to mixin class to share it with another Documenter.
tk0miya
force-pushed
the
8460_NewType
branch
from
0b508a0
to
6973888
Compare
tk0miya
commented
Nov 22, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Feature or Bugfix
Purpose
A custom type defined by typing.NewType was rendered as a function
because the generated type is a function having special attributes.
This renders it as a variable.
Note: The module name where the NewType object defined is lost on
generating it. So it is hard to make cross-reference for these custom
types.