autodoc: an imported TypeVar is not resolved (refs: #8415) #8426
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
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
174c1e7
to
42fc5aa
Compare
tk0miya
commented
Nov 15, 2020
tk0miya
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
42fc5aa
to
c16a71c
Compare
tk0miya
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
2c1da46
to
6c71b5b
Compare
tk0miya
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
6c71b5b
to
4b382ed
Compare
tk0miya
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
4b382ed
to
725ed3d
Compare
So far, a TypeVar is rendered without module name. As a result, it could not be resolved if it is imported from other modules. This prepends its module name and make it resolvable. This is available only in Python 3.7 or above. As a side effect, all of TypeVars are displayed with module name. It should be fixed in latter step (refs: sphinx-doc#7119)
tk0miya
force-pushed
the
8415_unresolved_imported_TypeVar
branch
from
725ed3d
to
7d3cc38
Compare
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
could not be resolved if it is imported from other modules. This
prepends its module name and make it resolvable.
Python 3.6 or abovePython 3.7 or above.should be fixed in latter step (refs: Allow unqualified type hint names in generated docs #7119)