Fix #8460: autodata directive does not display the detail of TypeVars #8471
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
…f TypeVars The details are only shown when automodule directive is used. This allows to document them via other auto* directives.
tk0miya
commented
Nov 22, 2020
| @@ -1750,27 +1758,31 @@ def test_autodoc_TypeVar(app): | |||
| '', | |||
| " alias of TypeVar('T1')", | |||
| '', | |||
| '', | |||
| '.. py:data:: T3', | |||
| ' :module: target.typevar', | |||
| '', | |||
| ' T3', | |||
| '', | |||
| " alias of TypeVar('T3', int, str)", | |||
There was a problem hiding this comment.
I'll make these arguments hyperlinked in the next step.
There was a problem hiding this comment.
I don't see anything for the bound parameter for TypeVar. It should be accessible via the __bound__ attribute. It's important information to display.
There was a problem hiding this comment.
Could you file a new issue? Then we'll consider improving it.
tk0miya
commented
Nov 23, 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
allows to document them via other auto* directives.