Skip to content

astral-sh/docstring-adder

Repository files navigation

docstring-adder


A professorial adder inscribing documentation at his desk, on which lies a ball of string

A codemod to auto-add docstrings to stub files


It's easiest to use this tool using uv.

Either install the tool using uv tool install git+https://github.com/astral-sh/docstring-adder and then invoke it using the add-docstrings command, or invoke it directly using uvx --from=git+https://github.com/astral-sh/docstring-adder add-docstrings.

Consult the module-level docstring in add_docstrings.py for more details on how the tool works. Run uvx --from=git+https://github.com/astral-sh/docstring-adder add-docstrings --help for information on the various CLI options the tool supports.

About

Add docstrings to stubs

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages