docstring-format-checker 0.3.0__tar.gz → 0.4.0__tar.gz

{docstring_format_checker-0.3.0 → docstring_format_checker-0.4.0}/PKG-INFO

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

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

{docstring_format_checker-0.3.0 → docstring_format_checker-0.4.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.3.0"
+__version__ = "v0.4.0"
 __author__ = "Chris Mahoney"
 __email__ = "docstring-format-checker@data-science-extensions.com"
 

{docstring_format_checker-0.3.0 → docstring_format_checker-0.4.0}/src/docstring_format_checker/cli.py

@@ -302,6 +302,29 @@ def _show_check_examples_callback(ctx: Context, param: CallbackParam, value: boo
     raise Exit()
 
 
+def _format_error_messages(error_message: str) -> str:
+    """
+    !!! note "Summary"
+        Format error messages for better readability in CLI output.
+
+    Params:
+        error_message (str):
+            The raw error message that may contain semicolon-separated errors
+
+    Returns:
+        (str):
+            Formatted error message with each error prefixed with "- " and separated by ";\n"
+    """
+    if "; " in error_message:
+        # Split by semicolon and rejoin with proper formatting
+        errors: list[str] = error_message.split("; ")
+        formatted_errors: list[str] = [f"- {error.strip()}" for error in errors if error.strip()]
+        return ";\n".join(formatted_errors) + "."
+    else:
+        # Single error message
+        return f"- {error_message.strip()}."
+
+
 def _display_results(results: dict[str, list[DocstringError]], quiet: bool, verbose: bool) -> int:
     """
     !!! note "Summary"
@@ -340,12 +363,16 @@ def _display_results(results: dict[str, list[DocstringError]], quiet: bool, verb
         for file_path, errors in results.items():
             for i, error in enumerate(errors):
                 file_display: str = file_path if i == 0 else ""
+
+                # Format error message with improved formatting
+                formatted_error_message: str = _format_error_messages(error.message)
+
                 table.add_row(
                     file_display,
                     str(error.line_number) if error.line_number > 0 else "",
                     error.item_name,
                     error.item_type,
-                    error.message,
+                    formatted_error_message,
                 )
         console.print(table)
 
@@ -354,12 +381,15 @@ def _display_results(results: dict[str, list[DocstringError]], quiet: bool, verb
         for file_path, errors in results.items():
             console.print(f"{NEW_LINE}[cyan]{file_path}[/cyan]")
             for error in errors:
+                # Format error message with improved formatting
+                formatted_error_message: str = _format_error_messages(error.message)
+
                 if error.line_number > 0:
                     console.print(
-                        f"  [red]Line {error.line_number}[/red] - {error.item_type} '{error.item_name}': {error.message}"
+                        f"  [red]Line {error.line_number}[/red] - {error.item_type} '{error.item_name}': {formatted_error_message}"
                     )
                 else:
-                    console.print(f"  [red]Error[/red]: {error.message}")
+                    console.print(f"  [red]Error[/red]: {formatted_error_message}")
 
     # Summary
     console.print(f"{NEW_LINE}[red]Found {total_errors} error(s) in {total_files} file(s)[/red]")

{docstring_format_checker-0.3.0 → docstring_format_checker-0.4.0}/src/docstring_format_checker/core.py

@@ -860,7 +860,7 @@ class DocstringChecker:
                 if has_colon:
                     errors.append(
                         f"Section '{section_title_clean}' is an admonition, therefore it should not end with ':', "
-                        f"see: {match.group(0)}"
+                        f"see: '{match.group(0)}'"
                     )
 
         # Check non-admonition sections (should end with colon)
@@ -878,7 +878,7 @@ class DocstringChecker:
                     if not has_colon:
                         errors.append(
                             f"Section '{section_name}' is non-admonition, therefore it must end with ':', "
-                            f"see: {line}"
+                            f"see: '{line}'"
                         )
 
         return errors
@@ -976,8 +976,8 @@ class DocstringChecker:
                         # Pattern: name (type): or (type):
                         if not re.search(r"\([^)]+\):", stripped_line):
                             errors.append(
-                                f"Section '{current_section.name}' (type: {current_section.type}) requires "
-                                f"parenthesized types, missing in: '{stripped_line}'"
+                                f"Section '{current_section.name}' (type: '{current_section.type}') requires "
+                                f"parenthesized types, see: '{stripped_line}'"
                             )
 
                     # For list_type sections, check format like "(Type):"
@@ -985,8 +985,8 @@ class DocstringChecker:
                         # Pattern: (Type):
                         if not re.search(r"^\s*\([^)]+\):", stripped_line):
                             errors.append(
-                                f"Section '{current_section.name}' (type: {current_section.type}) requires "
-                                f"parenthesized types, missing in: '{stripped_line}'"
+                                f"Section '{current_section.name}' (type: '{current_section.type}') requires "
+                                f"parenthesized types, see: '{stripped_line}'"
                             )
 
         return errors