We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
The numpydoc style guide lists non-method class attributes with type and description, similar to function parameter docstrings.
eg
Attributes ---------- x : float Description of attribute `x`. y : float Description of attribute `y`.
It looks like at the moment the numpydoc template only templates out type for function parameters.
When running :Neogen on the my dummy class I get the following docstring:
:Neogen
class DummyClass: """[TODO:description] Attributes ---------- x : [TODO:attribute] y : [TODO:attribute] """ x: int y: float
Ideally I'd like to see
""" ... Attributes ---------- x : int [TODO:description] y : float [TODO:description] ... """
Should type be a part of class attribute docstrings?
The text was updated successfully, but these errors were encountered:
No branches or pull requests
The numpydoc style guide lists non-method class attributes with type and description, similar to function parameter docstrings.
eg
It looks like at the moment the numpydoc template only templates out type for function parameters.
When running
:Neogen
on the my dummy class I get the following docstring:Ideally I'd like to see
Should type be a part of class attribute docstrings?
The text was updated successfully, but these errors were encountered: