summaryrefslogtreecommitdiff
path: root/doc/user_guide/messages/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user_guide/messages/index.rst')
-rw-r--r--doc/user_guide/messages/index.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/user_guide/messages/index.rst b/doc/user_guide/messages/index.rst
new file mode 100644
index 000000000..f21efb539
--- /dev/null
+++ b/doc/user_guide/messages/index.rst
@@ -0,0 +1,34 @@
+.. _messages:
+
+########
+Messages
+########
+
+.. toctree::
+ :maxdepth: 2
+ :hidden:
+
+
+ messages_list.rst
+ message-control.rst
+
+Pylint can emit various messages. These are categorized according
+to categories corresponding to bit-encoded exit codes:
+
+* :ref:`Fatal` (1)
+* :ref:`Error` (2)
+* :ref:`Warning` (4)
+* :ref:`Convention` (8)
+* :ref:`Refactor` (16)
+* :ref:`Information` (NA)
+
+A list of these messages can be found in :ref:`messages-list`
+
+Disabling messages
+==================
+
+``pylint`` has an advanced message control for its checks, offering the ability
+to enable / disable a message either from the command line or from the configuration
+file, as well as from the code itself.
+
+For more detail see :ref:`message-control`