Update pydocstringformatter to 0.4.0 (#5787)

Author: DanielNoord

.pre-commit-config.yaml

@@ -96,7 +96,7 @@ repos:
         args: [--prose-wrap=always, --print-width=88]
         exclude: tests(/.*)*/data
   - repo: https://github.com/DanielNoord/pydocstringformatter
-    rev: v0.2.0
+    rev: v0.4.0
     hooks:
       - id: pydocstringformatter
         exclude: *fixtures

doc/exts/pylint_extensions.py

@@ -16,7 +16,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_messages.py

@@ -18,10 +18,10 @@
 from pylint.utils import get_rst_title
 
 PYLINT_BASE_PATH = Path(__file__).resolve().parent.parent.parent
-"""Base path to the project folder"""
+"""Base path to the project folder."""
 
 PYLINT_MESSAGES_PATH = PYLINT_BASE_PATH / "doc" / "messages"
-"""Path to the messages documentation folder"""
+"""Path to the messages documentation folder."""
 
 
 MSG_TYPES_DOC = {k: v if v != "info" else "information" for k, v in MSG_TYPES.items()}
@@ -218,7 +218,7 @@ def build_messages_pages(app: Optional[Sphinx]) -> None:
 
 
 def setup(app: Sphinx) -> None:
-    """Connects the extension to the Sphinx process"""
+    """Connects the extension to the Sphinx process."""
     # Register callback at the builder-inited Sphinx event
     # See https://www.sphinx-doc.org/en/master/extdev/appapi.html
     app.connect("builder-inited", build_messages_pages)

examples/custom_raw.py

@@ -10,7 +10,7 @@
 
 
 class MyRawChecker(BaseChecker):
-    """check for line continuations with '\' instead of using triple
+    """Check for line continuations with '\' instead of using triple
     quoted string or parenthesis
     """
 
@@ -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
         """

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
@@ -75,7 +75,7 @@ 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>,
+    """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
     """
@@ -138,7 +138,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])