-
Notifications
You must be signed in to change notification settings - Fork 2
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
Docstring formats #140
Comments
Hi there! In theory it should work fine with all of those docstring formats, but thanks for pointing it out. The package relies on https://github.com/rr-/docstring_parser for parsing the docstrings, which supports ReST, Google, Numpydoc and Epydoc docstrings. I will mention it in the README.md and probably add some unit tests. Feel free to try it out and let me know if you run into any issues! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Does this suggestion already exist?
Feature description
From the examples it seems like currently only numpy style docstrings are supported.
Is there any plan to support other docstring conventions. The 3 major ones in python are
Numpy
Google
rst
The text was updated successfully, but these errors were encountered: