Skip to content

Commit 4b52be5

Browse files
committed
Mention the # noqa feature in the documentation; issue #180
1 parent 15392bd commit 4b52be5

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

docs/intro.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -191,21 +191,21 @@ This is the current list of error and warning codes:
191191
| E113 | unexpected indentation |
192192
+----------+----------------------------------------------------------------------+
193193
+----------+----------------------------------------------------------------------+
194-
| E121 | continuation line indentation is not a multiple of four |
194+
| E121 (^) | continuation line indentation is not a multiple of four |
195195
+----------+----------------------------------------------------------------------+
196-
| E122 | continuation line missing indentation or outdented |
196+
| E122 (^) | continuation line missing indentation or outdented |
197197
+----------+----------------------------------------------------------------------+
198-
| E123 | closing bracket does not match indentation of opening bracket's line |
198+
| E123 (^) | closing bracket does not match indentation of opening bracket's line |
199199
+----------+----------------------------------------------------------------------+
200-
| E124 | closing bracket does not match visual indentation |
200+
| E124 (^) | closing bracket does not match visual indentation |
201201
+----------+----------------------------------------------------------------------+
202-
| E125 | continuation line does not distinguish itself from next logical line |
202+
| E125 (^) | continuation line does not distinguish itself from next logical line |
203203
+----------+----------------------------------------------------------------------+
204-
| E126 | continuation line over-indented for hanging indent |
204+
| E126 (^) | continuation line over-indented for hanging indent |
205205
+----------+----------------------------------------------------------------------+
206-
| E127 | continuation line over-indented for visual indent |
206+
| E127 (^) | continuation line over-indented for visual indent |
207207
+----------+----------------------------------------------------------------------+
208-
| E128 | continuation line under-indented for visual indent |
208+
| E128 (^) | continuation line under-indented for visual indent |
209209
+----------+----------------------------------------------------------------------+
210210
+----------+----------------------------------------------------------------------+
211211
| **E2** | *Whitespace* |
@@ -280,7 +280,7 @@ This is the current list of error and warning codes:
280280
+----------+----------------------------------------------------------------------+
281281
| **E5** | *Line length* |
282282
+----------+----------------------------------------------------------------------+
283-
| E501 | line too long (82 > 79 characters) |
283+
| E501 (^) | line too long (82 > 79 characters) |
284284
+----------+----------------------------------------------------------------------+
285285
| E502 | the backslash is redundant between brackets |
286286
+----------+----------------------------------------------------------------------+
@@ -293,9 +293,9 @@ This is the current list of error and warning codes:
293293
+----------+----------------------------------------------------------------------+
294294
| E703 | statement ends with a semicolon |
295295
+----------+----------------------------------------------------------------------+
296-
| E711 | comparison to None should be 'if cond is None:' |
296+
| E711 (^) | comparison to None should be 'if cond is None:' |
297297
+----------+----------------------------------------------------------------------+
298-
| E712 | comparison to True should be 'if cond is True:' or 'if cond:' |
298+
| E712 (^) | comparison to True should be 'if cond is True:' or 'if cond:' |
299299
+----------+----------------------------------------------------------------------+
300300
| E721 | do not compare types, use 'isinstance()' |
301301
+----------+----------------------------------------------------------------------+
@@ -341,6 +341,11 @@ This is the current list of error and warning codes:
341341
and **E242** are ignored because they are not rules unanimously accepted,
342342
and `PEP 8`_ does not enforce them.
343343

344+
**(^)** These checks can be disabled at the line level using the ``# noqa``
345+
special comment. This possibility should be reserved for special cases.
346+
347+
*Special cases aren't special enough to break the rules.*
348+
344349

345350
Note: most errors can be listed with such one-liner::
346351

0 commit comments

Comments
 (0)