diff options
| author | Antoine Gallix <antoine.gallix@gmail.com> | 2019-03-20 15:12:14 +0100 |
|---|---|---|
| committer | Antoine Gallix <antoine.gallix@gmail.com> | 2019-03-20 15:12:14 +0100 |
| commit | e22ed0743e2ff992fb43958feae6ae55863fbf27 (patch) | |
| tree | ac9befbbd4b134b057561a71b138008af8b05939 /docs/source/user | |
| parent | d365e06d7ebeceec1b103c9f5c7e738ebe7401b3 (diff) | |
| download | flake8-e22ed0743e2ff992fb43958feae6ae55863fbf27.tar.gz | |
document max-doc-length option
Diffstat (limited to 'docs/source/user')
| -rw-r--r-- | docs/source/user/options.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index ba31691..3b1c43d 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -62,6 +62,8 @@ Index of Options - :option:`flake8 --max-line-length` +- :option:`flake8 --max-doc-length` + - :option:`flake8 --select` - :option:`flake8 --disable-noqa` @@ -520,6 +522,28 @@ Options and their Descriptions max-line-length = 79 +.. option:: --max-doc-length=<n> + + :ref:`Go back to index <top>` + + Set the maximum length that a comment or docstring line may be. + + By default, there is no limit on documentation line length. + + Command-line example: + + .. prompt:: bash + + flake8 --max-doc-length 99 dir/ + + This **can** be specified in config files. + + Example config file usage: + + .. code-block:: ini + + max-doc-length = 79 + .. option:: --select=<errors> |