search

eonu / feud

Build powerful CLIs with simple idiomatic Python, driven by type hints. Not all arguments are bad.
https://feud.readthedocs.io
MIT License
57 stars 2 forks source link

Docstring formats #140

Closed vikigenius closed 9 months ago

vikigenius commented 10 months ago

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

eonu commented 10 months ago

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!