Py docstring type annotation #343
Open
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
So the type annotation is left out of the args list that's then used to
generate the docstring.
e.g. argument lists like:
def fn(first_arg: str, second_arg: int = 1):
'''
Args:
first_arg :
second_arg: (default 1)
'''
WJCFerguson
force-pushed
the
py_docstring_type_annotation
branch
from
62a7585
to
bf703c0
Compare
|
Thanks, I'll test it soon but otherwise looks good to me |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A few tweaks to the Python snippet fn for handling of args to generating docstrings, e.g. the
function_docstring(keyfd) snippet.Before this it was upset by newlines in arg lists, e.g.
And in addition, it didn't know what to do with type annotations, e.g:
It now excludes the type annotation from the docstring.
(I could see an argument for removing the default handling - my personal preference is to avoid duplicating the information - I'd be happy to modify the PR to do that, but who knows which users use and like this.)