Clean up and update TODO list.
[docutils.git] / .flake8
blob8d0bcb0b4e5288db14729ae5182a908f695bb400
1 [flake8]
2 # Problems that are either not fixed yet or allowed by PEP8:
3 ignore =
4   E123,
5   # E123: "closing bracket does not match indentation of opening bracket's line"
6   # PEP8 "may either line up under the first […] character of the last line …"
8   E125,
9   # E125: "continuation line with same indent as next logical line"
10   # allowed by PEP8 cf. https://github.com/PyCQA/pycodestyle/issues/126
12   E126,
13   # E126: "continuation line over-indented for hanging indent"
14   # some cases are mandated by PEP8 to distinguish hanging indent from nesting.
15   # Other cases improve readability.
17   E129,
18   # E129: "visually indented line with same indent as next logical line"
19   # allowed by PEP8
21   E226, E227, E228,
22   # E226: "missing whitespace around arithmetic operator"
23   # E227: "missing whitespace around bitwise or shift operator"
24   # E228: "missing whitespace around modulo operator"
25   # not generally frowned on by PEP8:
26   # "If operators with different priorities are used, consider adding
27   # whitespace around the operators with the lowest priority(ies).
28   # Use your own judgment; …"
30   W503,
31   # W503: "line break before binary operator"
32   # this is the recommended style (changed on April 16th, 2016)
34 # Allow exceptions for specific files (requires flake8 >= 3.7.0)
35 per-file-ignores =
36   # class definitions with "…: pass" on one line
37   docutils/docutils/__init__.py:E701
38   docutils/docutils/nodes.py:E701
39   docutils/docutils/io.py:E701
40   docutils/docutils/statemachine.py:E701
41   docutils/docutils/utils/__init__.py:E701
42   # start of error message should be visible in traceback
43   docutils/docutils/parsers/rst/directives/tables.py:E128
44   # complex regexp definitions
45   docutils/docutils/parsers/rst/states.py:E121,E128,E701
46   # deprecated module, will be removed
47   docutils/docutils/utils/error_reporting.py:E261
48   # module with 3rd-party origin
49   docutils/docutils/utils/math/math2html.py:E241,E501,E731
50   # generated auxiliary files
51   docutils/docutils/utils/math/unichar2tex.py:E122
52   docutils/docutils/utils/math/tex2unichar.py:E262,E501
53   docutils/docutils/utils/math/mathalphabet2unichar.py:E501
54   # allow aligning values in data-collections
55   docutils/docutils/utils/smartquotes.py:E241
56   docutils/docutils/utils/roman.py:E241,E701
57   docutils/docutils/utils/math/latex2mathml.py:E241,E501,E701
58   docutils/docutils/writers/xetex/__init__.py:E241
59   # also allow '##' to mark deactivated code:
60   docutils/docutils/writers/latex2e/__init__.py:E241,E266
62   # included configuration files referencing externally defined variables
63   docutils/test/functional/tests/*:F821
64   # deprecated module, will be removed
65   docutils/test/test_error_reporting.py:E261
66   # Lists with multi-line test output samples
67   # may contain long lines (E501)
68   # and are not indented (E122, E124, E128)
69   docutils/test/test_parsers/*:E122,E124,E128,E501
70   docutils/test/test_publisher.py:E501
71   docutils/test/test_readers/test_pep/*:E122,E128,E501
72   docutils/test/test_transforms/*:E122,E124,E128,E501
73   docutils/test/test_writers/*:E122,E124,E128,E501
74   # test output contains trailing whitespace, long lines, operator at end
75   docutils/test/test_writers/test_manpage.py:E122,E128,W291,E501,W504
77 exclude =
78   .venv
79   .tox
80   dist
81   *egg
82   build
83   sandbox/*