Closed SKalt closed 6 years ago
I added support for class docstrings. Let me know if you have any problem.
This is my test:
class DocblockTest(object):
"""Short summary.
Parameters
----------
f1 : type
Description of parameter `f1`.
f2 : type
Description of parameter `f2`.
Attributes
----------
field1 : type
Description of attribute `field1`.
"""
field1 = None
field2 = 1
def __init__(self, f1, f2):
self.field1 = f1
def othermethod(self, arg):
return self + arg
I don't see a methods section; field 2 was missed among the attributes. This v 0.5.0. Was I supposed to install a dev version? Thanks
The numpy style guide prescribes something like
and the google style guides requires the form
This package should be capable of templating these class docstrings.