docstring-format-checker 0.7.0__tar.gz → 0.8.0__tar.gz

{docstring_format_checker-0.7.0 → docstring_format_checker-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-format-checker
-Version: 0.7.0
+Version: 0.8.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-0.7.0 → docstring_format_checker-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring-format-checker"
-version = "v0.7.0"
+version = "v0.8.0"
 description = "A CLI tool to check and validate Python docstring formatting and completeness"
 readme = "README.md"
 license = "MIT"

{docstring_format_checker-0.7.0 → docstring_format_checker-0.8.0}/src/docstring_format_checker/__init__.py

@@ -4,7 +4,7 @@ Docstring Format Checker.
 A CLI tool to check and validate Python docstring formatting and completeness.
 """
 
-__version__ = "v0.7.0"
+__version__ = "v0.8.0"
 __author__ = "Chris Mahoney"
 __email__ = "docstring-format-checker@data-science-extensions.com"
 

{docstring_format_checker-0.7.0 → docstring_format_checker-0.8.0}/src/docstring_format_checker/core.py

@@ -1015,19 +1015,42 @@ class DocstringChecker:
                                 )
                     # For list_name_and_type sections, check format like "name (type):" or "(type):"
                     elif current_section.type == "list_name_and_type":
-                        # Pattern: name (type): or (type):
-                        # But skip if it doesn't look like a parameter definition (e.g., has multiple words before the colon)
-                        colon_part = stripped_line.split(":")[0].strip()
-                        # Skip if it contains phrases that indicate it's a description, not a parameter
-                        if any(
-                            word in colon_part.lower() for word in ["default", "output", "format", "show", "example"]
-                        ):
+                        # Check if this line has parentheses and looks like a parameter definition
+                        if re.search(r"\([^)]+\):", stripped_line):
+                            # This is a valid parameter definition line, remember its indentation
+                            type_line_indent = current_indent
                             continue
+                        else:
+                            # Check if this is likely a description line based on various criteria
+                            colon_part = stripped_line.split(":")[0].strip()
+
+                            # Skip if it contains phrases that indicate it's a description, not a parameter
+                            if any(
+                                word in colon_part.lower()
+                                for word in ["default", "output", "format", "show", "example"]
+                            ):
+                                continue
 
-                        if not re.search(r"\([^)]+\):", stripped_line):
-                            errors.append(
-                                f"Section '{current_section.name}' (type: '{current_section.type}') requires "
-                                f"parenthesized types, see: '{stripped_line}'"
-                            )
+                            # Skip if it starts with bullet points or list markers
+                            if stripped_line.strip().startswith(("-", "*", "•", "+")):
+                                continue
+
+                            # If we have found a parameter definition, check if this is a description line
+                            if type_line_indent is not None:
+                                # Skip if this is more indented than the parameter definition (description line)
+                                if current_indent > type_line_indent:
+                                    continue
+
+                            # Skip if the line before the colon contains multiple words (likely description)
+                            words_before_colon = colon_part.split()
+                            if len(words_before_colon) > 2:  # More than "param_name (type)"
+                                continue
+
+                            # Only flag lines that could reasonably be parameter definitions
+                            if ":" in stripped_line and not stripped_line.strip().startswith("#"):
+                                errors.append(
+                                    f"Section '{current_section.name}' (type: '{current_section.type}') requires "
+                                    f"parenthesized types, see: '{stripped_line}'"
+                                )
 
         return errors