mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-09 22:34:17 +00:00
document max-doc-length option
This commit is contained in:
parent
d365e06d7e
commit
e22ed0743e
1 changed files with 24 additions and 0 deletions
|
|
@ -62,6 +62,8 @@ Index of Options
|
||||||
|
|
||||||
- :option:`flake8 --max-line-length`
|
- :option:`flake8 --max-line-length`
|
||||||
|
|
||||||
|
- :option:`flake8 --max-doc-length`
|
||||||
|
|
||||||
- :option:`flake8 --select`
|
- :option:`flake8 --select`
|
||||||
|
|
||||||
- :option:`flake8 --disable-noqa`
|
- :option:`flake8 --disable-noqa`
|
||||||
|
|
@ -520,6 +522,28 @@ Options and their Descriptions
|
||||||
|
|
||||||
max-line-length = 79
|
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>
|
.. option:: --select=<errors>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue