docstring-format-checker 1.8.0__tar.gz → 1.9.0__tar.gz

{docstring_format_checker-1.8.0 → docstring_format_checker-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-format-checker
-Version: 1.8.0
+Version: 1.9.0
 Summary: A CLI tool to check and validate Python docstring formatting and completeness
 Author: Chris Mahoney
 Author-email: Chris Mahoney <docstring-format-checker@data-science-extensions.com>

{docstring_format_checker-1.8.0 → docstring_format_checker-1.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring-format-checker"
-version = "1.8.0"
+version = "1.9.0"
 description = "A CLI tool to check and validate Python docstring formatting and completeness"
 readme = "README.md"
 license = "MIT"
@@ -114,6 +114,7 @@ filterwarnings = [
 addopts = [
     "--verbose",
     "--verbose",
+    "--diff-width=120",
     "--cov=src/docstring_format_checker",
     "--cov-report=term",
     "--cov-report=html:cov-report/html",

{docstring_format_checker-1.8.0 → docstring_format_checker-1.9.0}/src/docstring_format_checker/core.py

@@ -1000,7 +1000,7 @@ class DocstringChecker:
                 List of parameter names found in the Params section.
         """
         documented_params: list[str] = []
-        param_pattern: str = r"^\s*(\w+)\s*\([^)]+\):"
+        param_pattern: str = r"^\s*(\*{0,2}\w+)\s*\([^)]+\):"
         lines: list[str] = docstring.split("\n")
         in_params_section: bool = False
 
@@ -1039,12 +1039,30 @@ class DocstringChecker:
         """
         error_parts: list[str] = []
 
-        if missing_in_docstring:
-            missing_str: str = "', '".join(missing_in_docstring)
+        # Create copies to avoid mutating inputs
+        missing_copy: list[str] = list(missing_in_docstring)
+        extra_copy: list[str] = list(extra_in_docstring)
+
+        # Check for asterisk mismatch
+        # We iterate over a copy of missing_copy to allow modification
+        for missing in list(missing_copy):
+            for extra in list(extra_copy):
+                if extra.lstrip("*") == missing:
+                    asterisk_count: int = len(extra) - len(extra.lstrip("*"))
+                    asterisk_word: str = "asterisk" if asterisk_count == 1 else "asterisks"
+                    error_parts.append(
+                        f"  - Parameter '{missing}' found in docstring as '{extra}'. Please remove the {asterisk_word}."
+                    )
+                    missing_copy.remove(missing)
+                    extra_copy.remove(extra)
+                    break
+
+        if missing_copy:
+            missing_str: str = "', '".join(missing_copy)
             error_parts.append(f"  - In signature but not in docstring: '{missing_str}'")
 
-        if extra_in_docstring:
-            extra_str: str = "', '".join(extra_in_docstring)
+        if extra_copy:
+            extra_str: str = "', '".join(extra_copy)
             error_parts.append(f"  - In docstring but not in signature: '{extra_str}'")
 
         return "Parameter mismatch:\n" + "\n".join(error_parts)