DOKK / manpages / debian 12 / python3-docformatter / docformatter.1.en
DOCFORMATTER(1) User Commands DOCFORMATTER(1)

docformatter - Formats docstrings to follow Python PEP 257 (Python 3)

usage: docformatter [-h] [-i | -c] [-r] [-e [EXCLUDE ...]]

[--wrap-summaries length] [--wrap-descriptions length]
[--blank] [--pre-summary-newline] [--make-summary-multi-line] [--force-wrap] [--range line line] [--docstring-length length length] [--version] files [files ...]

Formats docstrings to follow PEP 257.

files to format or '-' for standard in

show this help message and exit
make changes to files instead of printing diffs
only check and report incorrectly formatted files
drill down directories recursively
exclude directories and files by names
wrap long summary lines at this length; set to 0 to disable wrapping (default: 79)
wrap descriptions at this length; set to 0 to disable wrapping (default: 72)
add blank line after description
add a newline before the summary of a multi-line docstring
add a newline before and after the summary of a oneline docstring
force descriptions to be wrapped even if it may result in a mess
apply docformatter to docstrings between these lines; line numbers are indexed at 1
apply docformatter to docstrings of given length
show program's version number and exit
October 2022 docformatter 1.4