Skip to content
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

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

Open
graik opened this issue Aug 10, 2017 · 1 comment
Open

Comments

@graik
Copy link

graik commented Aug 10, 2017

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.

@dadadel
Copy link
Owner

dadadel commented Sep 26, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants