docformatter

---

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

Backend: pants.core

Config section: [docformatter]

Basic options

skip

--[no-]docformatter-skip
PANTS_DOCFORMATTER_SKIP

default: False

Don't use docformatter when running /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 fmt and /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 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.3.1,<1.4

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.

entry_point

--docformatter-entry-point=<str>
PANTS_DOCFORMATTER_ENTRY_POINT

default: docformatter:main

The main module for the tool. Usually, you will not want to change this from the default.

interpreter_constraints

--docformatter-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTS

default:

[
  "CPython==2.7.*",
  "CPython>=3.4,<3.9"
]

Python interpreter constraints for this tool.

Deprecated options

None