Options

Below is the help output:

usage: docformatter [-h] [-i] [-r] [--wrap-summaries length]
[--wrap-descriptions length] [--no-blank]
[--pre-summary-newline] [--force-wrap] [--range line line]
[--version]
files [files ...]
Formats docstrings to follow PEP 257.
positional arguments:
files files to format
optional arguments:
-h, --help show this help message and exit
-i, --in-place make changes to files instead of printing diffs
-r, --recursive drill down directories recursively
--wrap-summaries length
wrap long summary lines at this length (default: 79)
--wrap-descriptions length
wrap descriptions at this length (default: 72)
--no-blank do not add blank line after description
--pre-summary-newline
add a newline before the summary of a multi-line
docstring
--force-wrap force descriptions to be wrapped even if it may result
in a mess
--range line line apply docformatter to docstrings between these lines;
line numbers are indexed at 1
--version show program's version number and exit

Wrapping descriptions

docformatter will wrap descriptions, but only in simple cases. If there is text
that seems like a bulleted/numbered list, docformatter will leave the
description as is:

- Item one.
- Item two.
- Item three.

This prevents the risk of the wrapping turning things into a mess. To force
even these instances to get wrapped use --force-wrap.