The Python docformatter tool (https://github.com/myint/docformatter).
Config section: [docformatter]
Basic options
--[no-]docformatter-skipPANTS_DOCFORMATTER_SKIPskip
default:
Don't use docformatter when running `./pants fmt` and `./pants lint`.
False
Don't use docformatter when running `./pants fmt` and `./pants lint`.
--docformatter-args="[<shell_str>, <shell_str>, ...]"PANTS_DOCFORMATTER_ARGSargs
default:
Arguments to pass directly to docformatter, e.g. `--docformatter-args="--wrap-summaries=100 --pre-summary-newline"`.
[]
Arguments to pass directly to docformatter, e.g. `--docformatter-args="--wrap-summaries=100 --pre-summary-newline"`.
Advanced options
--docformatter-version=<str>PANTS_DOCFORMATTER_VERSIONversion
default:
Requirement string for the tool.
docformatter>=1.3.1,<1.4
Requirement string for the tool.
--docformatter-extra-requirements="['<str>', '<str>', ...]"PANTS_DOCFORMATTER_EXTRA_REQUIREMENTSextra_requirements
default:
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
[]
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
--docformatter-entry-point=<str>PANTS_DOCFORMATTER_ENTRY_POINTentry_point
default:
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.
docformatter:main
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.
--docformatter-interpreter-constraints="['<str>', '<str>', ...]"PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTSinterpreter_constraints
default:
Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.
[ "CPython==2.7.*", "CPython>=3.4,<3.9" ]
Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.
Deprecated options
None
Updated about a month ago