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

Docstring formats #140

Closed
1 task done
vikigenius opened this issue Jan 8, 2024 · 1 comment
Closed
1 task done

Docstring formats #140

vikigenius opened this issue Jan 8, 2024 · 1 comment

Comments

@vikigenius
Copy link

Does this suggestion already exist?

  • This is a new feature!

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

@eonu
Copy link
Owner

eonu commented Jan 8, 2024

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!

@eonu eonu closed this as completed Feb 5, 2024
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