.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH DOCFORMATTER "1" "October 2022" "docformatter 1.4" "User Commands"
.SH NAME
docformatter \-  Formats docstrings to follow Python PEP 257 (Python 3)
.SH DESCRIPTION
usage: docformatter [\-h] [\-i | \fB\-c]\fR [\-r] [\-e [EXCLUDE ...]]
.TP
[\-\-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 ...]
.PP
Formats docstrings to follow PEP 257.
.SS "positional arguments:"
.TP
files
files to format or '\-' for standard in
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-i\fR, \fB\-\-in\-place\fR
make changes to files instead of printing diffs
.TP
\fB\-c\fR, \fB\-\-check\fR
only check and report incorrectly formatted files
.TP
\fB\-r\fR, \fB\-\-recursive\fR
drill down directories recursively
.TP
\fB\-e\fR [EXCLUDE ...], \fB\-\-exclude\fR [EXCLUDE ...]
exclude directories and files by names
.TP
\fB\-\-wrap\-summaries\fR length
wrap long summary lines at this length; set to 0 to
disable wrapping (default: 79)
.TP
\fB\-\-wrap\-descriptions\fR length
wrap descriptions at this length; set to 0 to disable
wrapping (default: 72)
.TP
\fB\-\-blank\fR
add blank line after description
.TP
\fB\-\-pre\-summary\-newline\fR
add a newline before the summary of a multi\-line
docstring
.TP
\fB\-\-make\-summary\-multi\-line\fR
add a newline before and after the summary of a oneline docstring
.TP
\fB\-\-force\-wrap\fR
force descriptions to be wrapped even if it may result
in a mess
.TP
\fB\-\-range\fR line line
apply docformatter to docstrings between these lines;
line numbers are indexed at 1
.TP
\fB\-\-docstring\-length\fR length length
apply docformatter to docstrings of given length
.TP
\fB\-\-version\fR
show program's version number and exit