diff options
| author | Claudiu Popa <pcmanticore@gmail.com> | 2019-02-13 11:13:18 +0100 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2019-02-13 11:15:12 +0100 |
| commit | e627af0c431a38814b058f5183a18bde6ff7f548 (patch) | |
| tree | e6cc479965785b8db1dc30212c31d2c438d1a4ad | |
| parent | c20bcf0b83c422c0943437864d41c3c33e8f4269 (diff) | |
| download | pylint-git-e627af0c431a38814b058f5183a18bde6ff7f548.tar.gz | |
Fix the doc errors
| -rw-r--r-- | doc/user_guide/message-control.rst | 76 | ||||
| -rw-r--r-- | doc/whatsnew/2.3.rst | 2 | ||||
| -rw-r--r-- | doc/whatsnew/index.rst | 1 |
3 files changed, 40 insertions, 39 deletions
diff --git a/doc/user_guide/message-control.rst b/doc/user_guide/message-control.rst index 8321b6642..82a8ec804 100644 --- a/doc/user_guide/message-control.rst +++ b/doc/user_guide/message-control.rst @@ -17,11 +17,11 @@ For all of these controls, ``pylint`` accepts the following values: * Corresponding category of the checks - * (C) convention related checks - * (R) refactoring related checks - * (W) various warnings - * (E) errors, for probable bugs in the code - * (F) fatal, if an error occurred which prevented ``pylint`` from doing further processing. + * ``C`` convention related checks + * ``R`` refactoring related checks + * ``W`` various warnings + * ``E`` errors, for probable bugs in the code + * ``F`` fatal, if an error occurred which prevented ``pylint`` from doing further processing. * All the checks with ``all`` @@ -35,56 +35,56 @@ The pragma controls can disable / enable: * All the violations on a single line -.. sourcecode:: python + .. sourcecode:: python - a, b = ... # pylint: disable=unbalanced-tuple-unpacking + a, b = ... # pylint: disable=unbalanced-tuple-unpacking * All the violations in a single scope -.. sourcecode:: python + .. sourcecode:: python - def test(): - # Disable all the no-member violations in this function - # pylint: disable=no-member - ... + def test(): + # Disable all the no-member violations in this function + # pylint: disable=no-member + ... * All the violations in a `block`. For instance, each separate branch of an ``if`` statement is considered a separate block, as in the following example: -.. sourcecode:: python + .. sourcecode:: python - def meth5(self): - # pylint: disable=no-member - # no error - print(self.bla) - if self.blop: - # pylint: enable=no-member - # disable all no-members for this block - print(self.blip) - else: - # This is affected by the scope disable - print(self.blip) - # pylint: enable=no-member - print(self.blip) - if self.blop: + def meth5(self): + # pylint: disable=no-member + # no error + print(self.bla) + if self.blop: + # pylint: enable=no-member + # disable all no-members for this block + print(self.blip) + else: + # This is affected by the scope disable + print(self.blip) # pylint: enable=no-member - # disable all no-members for this block - print(self.blip) - else: - # This emits a violation print(self.blip) + if self.blop: + # pylint: enable=no-member + # disable all no-members for this block + print(self.blip) + else: + # This emits a violation + print(self.blip) * If the violation occurs on a block starting line, then it applies only to that line -.. sourcecode:: python + .. sourcecode:: python - if self.blop: # pylint: disable=no-member; applies only to this line - # Here we get an error - print(self.blip) - else: - # error - print(self.blip) + if self.blop: # pylint: disable=no-member; applies only to this line + # Here we get an error + print(self.blip) + else: + # error + print(self.blip) diff --git a/doc/whatsnew/2.3.rst b/doc/whatsnew/2.3.rst index 53fd8408d..202859c8b 100644 --- a/doc/whatsnew/2.3.rst +++ b/doc/whatsnew/2.3.rst @@ -3,7 +3,7 @@ ************************** :Release: 2.3 -:Date: |TBA| +:Date: TBA Summary -- Release highlights diff --git a/doc/whatsnew/index.rst b/doc/whatsnew/index.rst index 1868cfe64..6dd43c866 100644 --- a/doc/whatsnew/index.rst +++ b/doc/whatsnew/index.rst @@ -9,6 +9,7 @@ High level descriptions of the most important changes between major Pylint versi .. toctree:: :maxdepth: 1 + 2.3.rst 2.2.rst 2.1.rst 2.0.rst |