You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 property decorator and it's subsequent getter, setter and deleter sub-functions are also not supported by numpydoc.
For example, after defining @property def myprop, the myprop.setter function decorator will still require a docstring for the setter function according to numpydoc, even though the docstring of the property class really ought to specify the whole property in one go. Usually there's only one reference/docstring point, so having a single docstring becomes a necessity.
Given these are standard library modules, can we implement module specific support?
I would be happy to give this a crack for both property attributes and dataclasses.
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 dataclass decorator, where you are going to pull the implied constructor from the type hinting attributes.
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: