diff options
author | Toshiki Hirao <hirao.toshiki.ho7@is.naist.jp> | 2018-04-22 16:00:41 -0400 |
---|---|---|
committer | Ian Stapleton Cordasco <graffatcolmingov@gmail.com> | 2018-04-22 15:00:41 -0500 |
commit | 11ba4cc825e3753a5b662efe41942b6b3021d7e5 (patch) | |
tree | 1a1648a6936b6e6dfc59377b57d3b5b6ff67d9af | |
parent | 17baca469a221da6b8c1531d13cfd33cb6eceed3 (diff) | |
download | pep8-11ba4cc825e3753a5b662efe41942b6b3021d7e5.tar.gz |
Add explanation about the default configuration
Closes gh-685
-rw-r--r-- | docs/intro.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/intro.rst b/docs/intro.rst index 80ef08f..70e7e81 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -426,6 +426,8 @@ This is the current list of error and warning codes: **(*)** In the default configuration, the checks **E121**, **E123**, **E126**, **E133**, **E226**, **E241**, **E242**, **E704**, **W503** and **W504** are ignored because they are not rules unanimously accepted, and `PEP 8`_ does not enforce them. +Please note that if the option **--ignore=errors** is used, +the default configuration will be overridden and ignore only the check(s) you skip. The check **W503** is mutually exclusive with check **W504**. The check **E133** is mutually exclusive with check **E123**. Use switch ``--hang-closing`` to report **E133** instead of **E123**. |