pyment icon indicating copy to clipboard operation
pyment copied to clipboard

existing class docstrings should not get empty Args: and Returns: sections

Open graik opened this issue 8 years ago • 1 comments

I tend to document my class with both a class doc string and a separate __init__ docstring for the constructor. Pyment seems to treat class doc strings as if they were method doc strings which is not helpful.

Desired behavior: only create Args: and Returns: sections if there is no separate __init__ doc string. Alternatively: never create empty Args: and Return: sections for classes. Only if there is :param etc statements in the original class doc string, creating these sections would make sense.

graik avatar Aug 10 '17 08:08 graik

@graik, This seems to make sense. Could you provide an example?

dadadel avatar Sep 26 '17 08:09 dadadel