Skip to content

Commit 9e6a14c

Browse files
Cleanup messages doc
1 parent dfa4708 commit 9e6a14c

File tree

3 files changed

+22
-21
lines changed

3 files changed

+22
-21
lines changed

doc/user_guide/messages/index.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,29 @@
33
Messages
44
========
55

6+
Pylint can emit various messages. These are categorized according
7+
to categories corresponding to bit-encoded exit codes:
8+
9+
* Fatal :ref:`Fatal` (1)
10+
* Error :ref:`Error` (2)
11+
* Warning :ref:`Warning` (4)
12+
* Convention :ref:`Convention` (8)
13+
* Refactor :ref:`Refactor` (16)
14+
* Information :ref:`Information` (NA)
15+
16+
A list of these messages can be found in :ref:`messages-list`
17+
18+
Disabling messages
19+
==================
20+
21+
``pylint`` has an advanced message control for its checks, offering the ability
22+
to enable / disable a message either from the command line or from the configuration
23+
file, as well as from the code itself.
24+
25+
For more detail see :ref:`messages_control`
26+
627
.. toctree::
728
:maxdepth: 1
829

9-
messages_introduction.rst
1030
messages_list.rst
1131
message_control.rst

doc/user_guide/messages/message_control.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33
Messages control
44
================
55

6-
``pylint`` has an advanced message control for its checks, offering the ability
7-
to enable / disable a message either from the command line or from the configuration
8-
file, as well as from the code itself.
9-
10-
For all of these controls, ``pylint`` accepts the following values:
6+
In order to control messages, ``pylint`` accepts the following values:
117

128
* a symbolic message: ``no-member``, ``undefined-variable`` etc.
139

doc/user_guide/messages/messages_introduction.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)