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

Which docstring style is supported? #26

Closed
moritzmeister opened this issue Jul 7, 2020 · 1 comment
Closed

Which docstring style is supported? #26

moritzmeister opened this issue Jul 7, 2020 · 1 comment

Comments

@moritzmeister
Copy link

Hi,

I am evaluating if the plugin would work for a python library, but I couldn't find any information which style it actually supports?
I only found issues regarding which styles it does not support, e.g. #25 and #23
So which is the actual style that the docstrings should have? Would be great to see this info and an example in the readme.

Thanks!

@tomchristie
Copy link
Owner

Markdown

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