Giters

eonu / feud

Build powerful CLIs with simple idiomatic Python, driven by type hints. Not all arguments are bad.

Home Page:https://feud.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docstring formats

vikigenius opened this issue · comments

commented

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

commented

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!