📦 astral-sh / docstring-adder

Add docstrings to stubs

★ 10 stars ⑂ 3 forks 👁 10 watching
docstring-adder
📥 Clone https://github.com/astral-sh/docstring-adder.git
HTTPS git clone https://github.com/astral-sh/docstring-adder.git
SSH git clone git@github.com:astral-sh/docstring-adder.git
CLI gh repo clone astral-sh/docstring-adder
ZIP Desktop VS Code
renovate[bot] renovate[bot] Update pre-commit dependencies (#80) 7743bb8 1 days ago 📝 History
📂 main View all commits →
📁 .github
📄 .gitignore
📄 .markdownlint.yaml
📄 .pre-commit-config.yaml
📄 add_docstrings.py
📄 pyproject.toml
📄 README.md
📄 uv.lock
📄 README.md

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.