Python Auto-Doc
Auto-generates PEP 257 docstrings for Python
How to install
With Forge Super installed, the button above opens the app on this extension, where you press Install. Nothing is installed until you do.
You can also open the Extensions panel in the app and search for Python Auto-Doc. The extension's id is python-autodoc-lsp.
Don't have Forge Super yet? Download it here.
README
From the extension's repository, written by its authors and not by Mentenaz. See the source.
Python Autodoc for Zed
Generates PEP 257 docstrings for Python functions and classes. Type """ on the line after a definition to trigger completion.
Handles typed parameters, return types, exceptions, dataclasses, async functions, *args/**kwargs, and nested functions.
Examples
- Function with typed parameters

- Function with exceptions

- Dataclasses

- Complex signatures

More examples can be found in examples/.
PEP 257 notes:
- Class docstrings get a summary only;
__init__parameters are documented in__init__ Nonereturn types are omittedRaises:is only generated when the function body containsraisestatements
License
MIT — see LICENSE.