docformatter

The Python docformatter tool (https://github.com/myint/docformatter).

Config section: [docformatter]

Basic options

skip

--[no-]docformatter-skip
PANTS_DOCFORMATTER_SKIP
default: False

Don't use docformatter when running `./pants fmt` and `./pants lint`.


args

--docformatter-args="[<shell_str>, <shell_str>, ...]"
PANTS_DOCFORMATTER_ARGS
default: []

Arguments to pass directly to docformatter, e.g. `--docformatter-args="--wrap-summaries=100 --pre-summary-newline"`.


Advanced options

version

--docformatter-version=<str>
PANTS_DOCFORMATTER_VERSION
default: docformatter>=1.4,<1.5

Requirement string for the tool.


extra_requirements

--docformatter-extra-requirements="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_EXTRA_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.


interpreter_constraints

--docformatter-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTS
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.


console_script

--docformatter-console-script=<str>
PANTS_DOCFORMATTER_CONSOLE_SCRIPT
default: docformatter

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.


entry_point

--docformatter-entry-point=<str>
PANTS_DOCFORMATTER_ENTRY_POINT
default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.


Deprecated options

None


Did this page help you?