Better capitalization in docstring, fixed number of char per line

Author: Pierre-Sassoulas

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
           - --remove-duplicate-keys
           - --remove-unused-variables
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.29.1
+    rev: v2.30.1
     hooks:
       - id: pyupgrade
         args: [--py36-plus]

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/custom_raw.py

@@ -10,8 +10,8 @@
 
 
 class MyRawChecker(BaseChecker):
-    """check for line continuations with '\' instead of using triple
-    quoted string or parenthesis
+    """Check for line continuations with '\' instead of using triple quoted string or
+    parenthesis.
     """
 
     __implements__ = IRawChecker
@@ -30,7 +30,7 @@ class MyRawChecker(BaseChecker):
     options = ()
 
     def process_module(self, node: nodes.Module) -> None:
-        """process a module
+        """Process a module.
 
         the module's content is accessible via node.stream() function
         """

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/__init__.py

@@ -19,7 +19,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
 
-"""utilities methods and classes for checkers
+"""Utilities methods and classes for checkers.
 
 Base id of standard checkers (used in msg and report ids):
 01: base
@@ -44,7 +44,6 @@
 
 The raw_metrics checker has no number associated since it doesn't emit any
 messages nor reports. XXX not true, emit a 07 report !
-
 """
 
 import sys
@@ -66,9 +65,8 @@ def table_lines_from_stats(
     old_stats: Optional[LinterStats],
     stat_type: Literal["duplicated_lines", "message_types"],
 ) -> List[str]:
-    """get values listed in <columns> from <stats> and <old_stats>,
-    and return a formatted list of values, designed to be given to a
-    ureport.Table object
+    """Get values listed in <columns> from <stats> and <old_stats>, and return a
+    formatted list of values, designed to be given to a ureport.Table object.
     """
     lines: List[str] = []
     if stat_type == "duplicated_lines":
@@ -129,7 +127,7 @@ def table_lines_from_stats(
 
 
 def initialize(linter):
-    """initialize linter with checkers in this package"""
+    """Initialize linter with checkers in this package."""
     register_plugins(linter, __path__[0])