-
-
Notifications
You must be signed in to change notification settings - Fork 167
Feature request: Add support for dataclasses #604
New issue
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
Comments
Whilst not directly related, I also notice that while the ability to track decorator functions has been added a while ago, specific support for the For example, after defining Given these are standard library modules, can we implement module specific support? I would be happy to give this a crack for both |
Also noticed this pull request related to long running issue #196 which touches on the use of type hinting to avoid requiring numpydoc to specify the type hinting with redundancy. This seems relevant for the |
Hi, i only noticed this from the mentioned PR, but i wanted ask what the problem is? (maybe i might be able to help) Running your example with which is what i expect when documenting both dataclasses and normal classes, e.g.: class Klass2:
"""
Klass description.
Attributes
----------
attr: int
Some attribute description.
"""
attr: int gives |
At the moment numpydoc will ignore "Attributes" section for dataclasses (or maybe I don't quite understand how to document dataclasses properly):
It would be great to have such a feature.
The text was updated successfully, but these errors were encountered: