Close #2755: autodoc: Support type_comment style annotation #6982
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
2755_type_comment_support
branch
2 times, most recently
from
010342a
to
a49b484
Compare
eric-wieser
reviewed
Jan 1, 2020
eric-wieser
reviewed
Jan 1, 2020
tk0miya
commented
Jan 1, 2020
tk0miya
force-pushed
the
2755_type_comment_support
branch
from
a49b484
to
314be09
Compare
tk0miya
commented
Jan 2, 2020
| @@ -983,8 +983,10 @@ def format_args(self, **kwargs: Any) -> str: | |||
| not inspect.isbuiltin(self.object) and | |||
| not inspect.isclass(self.object) and | |||
| hasattr(self.object, '__call__')): | |||
| self.env.app.emit('autodoc-before-format-args', self.object.__call__, False) | |||
There was a problem hiding this comment.
I don't think this is good way to do this. But we have to let handlers know the target object is bound method or not...
tk0miya
force-pushed
the
2755_type_comment_support
branch
2 times, most recently
from
2af277d
to
4fb1362
Compare
eric-wieser
reviewed
Jan 2, 2020
eric-wieser
reviewed
Jan 2, 2020
Note: python3.8+ or typed_ast is required
tk0miya
force-pushed
the
2755_type_comment_support
branch
from
4fb1362
to
59dacd8
Compare
|
@eric-wieser Thank you for quick and wise comment! Updated. |
|
OMG. |
|
oh, I closed this PR wrongly. I'll post another one again |
|
Error message seems truncated: Is there a way to get more info? |
Why not just reopen the PR? |
eric-wieser
reviewed
Jan 2, 2020
| elif isinstance(typ, (ast.Constant, ast.NameConstant)): # type: ignore | ||
| return repr(typ.value) | ||
| else: | ||
| raise NotImplementedError |
There was a problem hiding this comment.
Suggested change
| raise NotImplementedError | |
| raise NotImplementedError('Unable to render {} instances'.format(type(type).__name__)) |
|
Reposted as #6984 |
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