Added docs

Author: Nurdok

docs/release_notes.rst

@@ -5,6 +5,11 @@ Release Notes
 Current Development Version
 ---------------------------
 
+New Features
+
+* Added support for more flexible error selections using ``--ignore``,
+  ``--select``, ``--convention``, ``--add-ignore`` and ``--add-select``.
+
 Bug Fixes
 
 * Property setter and deleter methods are now treated as private and do not

docs/snippets/cli.rst

@@ -6,21 +6,44 @@ Usage
     Usage: pep257 [options] [<file|dir>...]
 
     Options:
-    --version             show program's version number and exit
-    -h, --help            show this help message and exit
-    -e, --explain         show explanation of each error
-    -s, --source          show source for each error
-    --ignore=<codes>      ignore a list comma-separated error codes, for
-                            example: --ignore=D101,D202
-    --match=<pattern>     check only files that exactly match <pattern> regular
+      --version             show program's version number and exit
+      -h, --help            show this help message and exit
+      -e, --explain         show explanation of each error
+      -s, --source          show source for each error
+      --select=<codes>      choose the basic list of checked errors by specifying
+                            which errors to check for (with a list of comma-
+                            separated error codes). for example:
+                            --select=D101,D202
+      --ignore=<codes>      choose the basic list of checked errors by specifying
+                            which errors to ignore (with a list of comma-separated
+                            error codes). for example: --ignore=D101,D202
+      --convention=<name>   choose the basic list of checked errors by specifying
+                            an existing convention. for example:
+                            --convention=pep257
+      --add-select=<codes>  amend the list of errors to check for by specifying
+                            more error codes to check.
+      --add-ignore=<codes>  amend the list of errors to check for by specifying
+                            more error codes to ignore.
+      --match=<pattern>     check only files that exactly match <pattern> regular
                             expression; default is --match='(?!test_).*\.py' which
                             matches files that don't start with 'test_' but end
                             with '.py'
-    --match-dir=<pattern>
+      --match-dir=<pattern>
                             search only dirs that exactly match <pattern> regular
                             expression; default is --match-dir='[^\.].*', which
                             matches all dirs that don't start with a dot
-    -d, --debug           print debug information
-    -v, --verbose         print status information
-    --count               print total number of errors to stdout
+      -d, --debug           print debug information
+      -v, --verbose         print status information
+      --count               print total number of errors to stdout
+
+Return Code
+^^^^^^^^^^^
+
++--------------+--------------------------------------------------------------+
+| 0            | Success - no violations                                      |
++--------------+--------------------------------------------------------------+
+| 1            | Some code violations were found                              |
++--------------+--------------------------------------------------------------+
+| 2            | Illegal usage - see error message                            |
++--------------+--------------------------------------------------------------+