APIΒΆ
If you’re looking to use this in an editor you’re probably looking for pydocstring.generate_docstring()
pydocstring |
Top level API - all you need to integrate with an editor, just call pydocstring.generate_docstring() with the source code and the position of your cursor. |
pydocstring.exc |
pydocstring exceptions |
pydocstring.formatters.google |
Google Docstring Formatter |
pydocstring.formatters.numpy |
Numpy Docstring Formatter |
pydocstring.formatters.reST |
reST Docstring Formatter |
pydocstring.cli |
pydocstring CLI provides entrypoints for CLI commands |