1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26<div align=center>
# docstring-adder
<br>
<img width="512" height="512" alt="A professorial adder inscribing documentation at his desk, on which lies a ball of string" src="https://github.com/user-attachments/assets/0eb96058-c110-4759-ade3-223f5734d20a" />
##
### A codemod to auto-add docstrings to stub files
</div>
---
It's easiest to use this tool using [uv](https://docs.astral.sh/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.