Better capitalization in docstring, fixed number of char per line

Author: Pierre-Sassoulas

doc/exts/pylint_extensions.py

@@ -2,7 +2,9 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-"""Script used to generate the extensions file before building the actual documentation."""
+"""Script used to generate the extensions file before building the actual
+documentation.
+"""
 
 import os
 import re
@@ -23,7 +25,7 @@
 
 
 def builder_inited(app):
-    """Output full documentation in ReST format for all extension modules"""
+    """Output full documentation in ReST format for all extension modules."""
     # PACKAGE/docs/exts/pylint_extensions.py --> PACKAGE/
     base_path = os.path.dirname(
         os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

doc/exts/pylint_features.py

@@ -2,7 +2,9 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-"""Script used to generate the features file before building the actual documentation."""
+"""Script used to generate the features file before building the actual
+documentation.
+"""
 
 import os
 

doc/user_guide/message-control.rst

@@ -112,7 +112,7 @@ Here's an example with all these rules in a single place:
             pass
 
         def meth1(self, arg):
-            """this issues a message"""
+            """This issues a message"""
             print(self)
 
         def meth2(self, arg):
@@ -122,14 +122,14 @@ Here's an example with all these rules in a single place:
                   + "foo")
 
         def meth3(self):
-            """test one line disabling"""
+            """Test one line disabling"""
             # no error
             print(self.bla) # pylint: disable=no-member
             # error
             print(self.blop)
 
         def meth4(self):
-            """test re-enabling"""
+            """Test re-enabling"""
             # pylint: disable=no-member
             # no error
             print(self.bla)
@@ -139,7 +139,7 @@ Here's an example with all these rules in a single place:
             print(self.blip)
 
         def meth5(self):
-            """test IF sub-block re-enabling"""
+            """Test IF sub-block re-enabling"""
             # pylint: disable=no-member
             # no error
             print(self.bla)
@@ -154,7 +154,7 @@ Here's an example with all these rules in a single place:
             print(self.blip)
 
         def meth6(self):
-            """test TRY/EXCEPT sub-block re-enabling"""
+            """Test TRY/EXCEPT sub-block re-enabling"""
             # pylint: disable=no-member
             # no error
             print(self.bla)
@@ -169,7 +169,7 @@ Here's an example with all these rules in a single place:
             print(self.blip)
 
         def meth7(self):
-            """test one line block opening disabling"""
+            """Test one line block opening disabling"""
             if self.blop: # pylint: disable=no-member
                 # error
                 print(self.blip)
@@ -180,7 +180,7 @@ Here's an example with all these rules in a single place:
             print(self.blip)
 
         def meth8(self):
-            """test late disabling"""
+            """Test late disabling"""
             # error
             print(self.blip)
             # pylint: disable=no-member
@@ -189,7 +189,7 @@ Here's an example with all these rules in a single place:
             print(self.blop)
 
         def meth9(self):
-            """test next line disabling"""
+            """Test next line disabling"""
             # no error
             # pylint: disable-next=no-member
             print(self.bla)

examples/deprecation_checker.py

@@ -1,6 +1,6 @@
-"""Example checker detecting deprecated functions/methods. Following example searches for usages of
-deprecated function `deprecated_function` and deprecated method `MyClass.deprecated_method`
-from module mymodule:
+"""Example checker detecting deprecated functions/methods. Following example searches
+for usages of deprecated function `deprecated_function` and deprecated method
+`MyClass.deprecated_method` from module mymodule:
 
 .. code-block:: console
     $ cat mymodule.py
@@ -59,7 +59,8 @@ class DeprecationChecker(DeprecatedMixin, BaseChecker):
     name = "deprecated"
 
     def deprecated_methods(self) -> Set[str]:
-        """Callback method called by DeprecatedMixin for every method/function found in the code.
+        """Callback method called by DeprecatedMixin for every method/function found in
+        the code.
 
         Returns:
             collections.abc.Container of deprecated function/method names.

pylint/__init__.py

@@ -19,7 +19,7 @@
 
 
 def run_pylint(argv: Optional[Sequence[str]] = None):
-    """Run pylint
+    """Run pylint.
 
     argv can be a sequence of strings normally supplied as arguments on the command line
     """
@@ -32,7 +32,7 @@ def run_pylint(argv: Optional[Sequence[str]] = None):
 
 
 def run_epylint(argv: Optional[Sequence[str]] = None):
-    """Run epylint
+    """Run epylint.
 
     argv can be a list of strings normally supplied as arguments on the command line
     """
@@ -42,7 +42,7 @@ def run_epylint(argv: Optional[Sequence[str]] = None):
 
 
 def run_pyreverse(argv: Optional[Sequence[str]] = None):
-    """Run pyreverse
+    """Run pyreverse.
 
     argv can be a sequence of strings normally supplied as arguments on the command line
     """
@@ -52,7 +52,7 @@ def run_pyreverse(argv: Optional[Sequence[str]] = None):
 
 
 def run_symilar(argv: Optional[Sequence[str]] = None):
-    """Run symilar
+    """Run symilar.
 
     argv can be a sequence of strings normally supplied as arguments on the command line
     """

pylint/__pkginfo__.py

@@ -6,7 +6,7 @@
 
 
 def get_numversion_from_version(v: str) -> Tuple:
-    """Kept for compatibility reason
+    """Kept for compatibility reason.
 
     See https://github.com/PyCQA/pylint/issues/4399
     https://github.com/PyCQA/pylint/issues/4420,

pylint/checkers/classes/special_methods_checker.py

@@ -1,7 +1,7 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-"""Special methods checker and helper function's module"""
+"""Special methods checker and helper function's module."""
 
 import astroid
 from astroid import nodes
@@ -23,8 +23,8 @@
 def _safe_infer_call_result(node, caller, context=None):
     """Safely infer the return value of a function.
 
-    Returns None if inference failed or if there is some ambiguity (more than
-    one node has been inferred). Otherwise, returns inferred value.
+    Returns None if inference failed or if there is some ambiguity (more than one node
+    has been inferred). Otherwise, returns inferred value.
     """
     try:
         inferit = node.infer_call_result(caller, context=context)
@@ -43,9 +43,7 @@ def _safe_infer_call_result(node, caller, context=None):
 
 
 class SpecialMethodsChecker(BaseChecker):
-    """Checker which verifies that special methods
-    are implemented correctly.
-    """
+    """Checker which verifies that special methods are implemented correctly."""
 
     __implements__ = (IAstroidChecker,)
     name = "classes"

pylint/checkers/ellipsis_checker.py

@@ -1,4 +1,4 @@
-"""Ellipsis checker for Python code"""
+"""Ellipsis checker for Python code."""
 from typing import TYPE_CHECKING
 
 from astroid import nodes
@@ -27,12 +27,13 @@ class EllipsisChecker(BaseChecker):
 
     @check_messages("unnecessary-ellipsis")
     def visit_const(self, node: nodes.Const) -> None:
-        """Check if the ellipsis constant is used unnecessarily.
-        Emit a warning when:
-         - A line consisting of an ellipsis is preceded by a docstring.
-         - A statement exists in the same scope as the ellipsis.
-           For example: A function consisting of an ellipsis followed by a
-           return statement on the next line.
+        """Check if the ellipsis constant is used unnecessarily. Emit a warning
+        when:
+
+        - A line consisting of an ellipsis is preceded by a docstring.
+        - A statement exists in the same scope as the ellipsis.
+          For example: A function consisting of an ellipsis followed by a
+          return statement on the next line.
         """
         if (
             node.pytype() == "builtins.Ellipsis"

pylint/checkers/mapreduce_checker.py

@@ -8,12 +8,12 @@
 
 
 class MapReduceMixin(metaclass=abc.ABCMeta):
-    """A mixin design to allow multiprocess/threaded runs of a Checker"""
+    """A mixin design to allow multiprocess/threaded runs of a Checker."""
 
     @abc.abstractmethod
     def get_map_data(self):
-        """Returns mergeable/reducible data that will be examined"""
+        """Returns mergeable/reducible data that will be examined."""
 
     @abc.abstractmethod
     def reduce_map_data(self, linter, data):
-        """For a given Checker, receives data for all mapped runs"""
+        """For a given Checker, receives data for all mapped runs."""

pylint/checkers/refactoring/implicit_booleaness_checker.py

@@ -127,9 +127,8 @@ def instance_has_bool(class_def: nodes.ClassDef) -> bool:
 
     @utils.check_messages("use-implicit-booleaness-not-len")
     def visit_unaryop(self, node: nodes.UnaryOp) -> None:
-        """`not len(S)` must become `not S` regardless if the parent block
-        is a test condition or something else (boolean expression)
-        e.g. `if not len(S):`
+        """`not len(S)` must become `not S` regardless if the parent block is a test
+        condition or something else (boolean expression) e.g. `if not len(S):`
         """
         if (
             isinstance(node, nodes.UnaryOp)
@@ -145,7 +144,7 @@ def visit_compare(self, node: nodes.Compare) -> None:
     def _check_use_implicit_booleaness_not_comparison(
         self, node: nodes.Compare
     ) -> None:
-        """Check for left side and right side of the node for empty literals"""
+        """Check for left side and right side of the node for empty literals."""
         is_left_empty_literal = utils.is_base_container(
             node.left
         ) or utils.is_empty_dict_literal(node.left)
@@ -210,7 +209,9 @@ def _check_use_implicit_booleaness_not_comparison(
 
     @staticmethod
     def base_classes_of_node(instance: nodes.ClassDef) -> List[str]:
-        """Return all the classes names that a ClassDef inherit from including 'object'."""
+        """Return all the classes names that a ClassDef inherit from including
+        'object'.
+        """
         try:
             return [instance.name] + [x.name for x in instance.ancestors()]
         except TypeError:

pylint/checkers/refactoring/recommendation_checker.py

@@ -102,7 +102,9 @@ def _check_consider_iterating_dictionary(self, node: nodes.Call) -> None:
             self.add_message("consider-iterating-dictionary", node=node)
 
     def _check_use_maxsplit_arg(self, node: nodes.Call) -> None:
-        """Add message when accessing first or last elements of a str.split() or str.rsplit()."""
+        """Add message when accessing first or last elements of a str.split() or
+        str.rsplit().
+        """
 
         # Check if call is split() or rsplit()
         if not (
@@ -337,7 +339,7 @@ def visit_const(self, node: nodes.Const) -> None:
 
     def _detect_replacable_format_call(self, node: nodes.Const) -> None:
         """Check whether a string is used in a call to format() or '%' and whether it
-        can be replaced by an f-string
+        can be replaced by an f-string.
         """
         if (
             isinstance(node.parent, nodes.Attribute)