Skip to content

Change Log

v0.11.0

v0.11.0 - Test Suite Reliability Improvement🔗

🏷v0.11.0
📆2025-09-10
🔗data-science-extensions/docstring-format-checker/releases/v0.11.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.10.0...v0.11.0

Updates

  • Fix typo
    Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View

  • Standardise admonition types and isolate test environment

    • Change admonition type from info to abstract for consistency in documentation formatting
    • Isolate configuration loading test by switching to temporary directory to prevent interference from existing project configuration files
    • Ensure test runs in clean environment by temporarily changing working directory and restoring original location afterwards (by chrimaho) View

  • Add or fix package docstrings (by chrimaho) View

  • Fix typo (by chrimaho) View

  • Fix typo (by chrimaho) View

v0.10.0

v0.10.0 - Enhanced CLI Architecture and Cross-Platform Test Reliability🔗

🏷v0.10.0
📆2025-09-10
🔗data-science-extensions/docstring-format-checker/releases/v0.10.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.9.0...v0.10.0

Updates

  • Improve test assertion robustness for CLI help text validation

    • Replace exact string matching with word-by-word validation to handle platform-specific line wrapping
    • Use all() function with generator expression to check each word individually in help output
    • Add explicit type annotation for output variable to improve code clarity
    • Ensure tests pass consistently across different terminal widths and operating systems (by chrimaho) View

  • Fix test assertions to handle platform-specific line wrapping

    • Remove trailing period from expected help text string to account for line wrapping variations across different platforms
    • Extract cleaned output to variable for better readability and maintainability
    • Ensure test reliability when help text formatting differs due to terminal width constraints (by chrimaho) View

  • Fix Windows CI issues: resolve temp file locking and help text assertion mismatches

    • Close all temporary files before CLI invocation to prevent Windows file locking errors
    • Update help text assertions to match actual output (completeness. vs completeness)
    • All 167 tests now pass with 100% code coverage locally (by chrimaho) View

  • Improve CI setup and fix test reliability issues

    • Add UV package manager setup in CD workflow for faster Python dependency management
    • Fix Python version handling to use UV for installing matrix versions while maintaining setup consistency
    • Improve test stability by adding f.flush() calls and proper temporary file name handling to prevent file system race conditions
    • Expand table border detection to handle various Unicode characters for more robust output validation
    • Update help text to better reflect tool capabilities including completeness checking
    • Fix test configuration to use proper Config objects instead of deprecated helper functions (by chrimaho) View

v0.9.0

v0.9.0 - Configuration Architecture Enhancement🔗

🏷v0.9.0
📆2025-09-10
🔗data-science-extensions/docstring-format-checker/releases/v0.9.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.8.0...v0.9.0

Updates
  • Refactor tests to utilize new Config structure and global configuration flags
    • Updated test_config.py to reflect changes in load_config function, ensuring it returns a Config object instead of a list of SectionConfig.
    • Enhanced assertions in test cases to validate global configuration values such as allow_undefined_sections, require_docstrings, and check_private.
    • Introduced test_global_config.py to cover new global configuration features, including loading from TOML files and validating behavior based on global flags.
    • Added tests for scenarios where undefined sections and missing docstrings are handled according to the global configuration settings. (by chrimaho) View

v0.8.0

v0.8.0 - Enhanced Docstring Validation Logic🔗

🏷v0.8.0
📆2025-09-09
🔗data-science-extensions/docstring-format-checker/releases/v0.8.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.7.0...v0.8.0

Updates
  • Improves validation logic for list sections with types
    Enhances the docstring checker to better distinguish between parameter
    definitions and description content in list_name_and_type sections.
    Previously flagged description lines containing colons as invalid parameter
    definitions. Now uses multiple criteria including indentation levels, word
    count analysis, and bullet point detection to avoid false positives.
    Prevents validation errors on legitimate description content while maintaining
    strict checking for actual parameter definition lines. (by chrimaho) View

v0.7.0

v0.7.0 - Enhanced Docstring Validation Logic🔗

🏷v0.7.0
📆2025-09-09
🔗data-science-extensions/docstring-format-checker/releases/v0.7.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.6.0...v0.7.0

Updates

  • Updates test expectations for parentheses validation
    Adjusts test assertions to reflect current implementation behavior where certain type annotations are skipped when no parenthesized types have been found yet.
    Changes expected error types from missing parentheses violations to undefined section errors, and removes assertions for cases that no longer generate errors due to the permissive logic. (by chrimaho) View

  • Update src/docstring_format_checker/core.py
    Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View

  • Fixes description line validation in list_type sections
    Improves docstring validation logic to properly handle description lines that contain colons in list_type sections.
    Previously, description lines indented under type definitions were incorrectly flagged as requiring parenthesized types. Now tracks indentation levels to distinguish between type definition lines and their corresponding descriptions.
    Adds comprehensive test coverage for various scenarios including multi-line descriptions, same-line descriptions, and invalid formats to ensure robust validation behavior. (by chrimaho) View

  • Correct output as list, ensure errors are on individual lines (by chrimaho) View

v0.6.0

v0.6.0 - Advanced List Output Formatting & Error Summary Display🔗

🏷v0.6.0
📆2025-09-08
🔗data-science-extensions/docstring-format-checker/releases/v0.6.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.5.0...v0.6.0

Updates
  • Resove issues with the output when -o list and with the summary stats on the printed output (by chrimaho) View

v0.5.0

v0.5.0 - Streamline CLI Architecture🔗

🏷v0.5.0
📆2025-09-07
🔗data-science-extensions/docstring-format-checker/releases/v0.5.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.4.0...v0.5.0

Updates

  • Increase code coverage (by chrimaho) View

  • Fix failing unit tests (by chrimaho) View

  • Add --examples/-e flags to the CLI, instead of using a sub-command (by chrimaho) View

  • Remove the unnecessary _parse_boolean_flag() function and all associated unit tests (by chrimaho) View

  • Remove all references to the --recursive/-r flag, and ensure that it will always be recursive by default (by chrimaho) View

  • Update docstring format in CLI module to be more pythonic (by chrimaho) View

v0.4.0

v0.4.0 - Enhance CLI Error Output Formatting🔗

🏷v0.4.0
📆2025-09-06
🔗data-science-extensions/docstring-format-checker/releases/v0.4.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.3.0...v0.4.0

Updates

  • Fix typo (by chrimaho) View

  • Enhance error message formatting in CLI output and add corresponding unit tests (by chrimaho) View

v0.3.0

v0.3.0 - Enhance Validation & Configuration Rules🔗

🏷v0.3.0
📆2025-09-06
🔗data-science-extensions/docstring-format-checker/releases/v0.3.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.2.0...v0.3.0

Updates

  • Fix typo (by chrimaho) View

  • Add additional unit tests to check more edge cases (by chrimaho) View

  • Add more unit tests for edge cases (by chrimaho) View

  • Enhance admonition validation by ensuring admonition is a string and refining section name matching patterns (by chrimaho) View

  • Add parentheses validation for list type sections in docstring checks (by chrimaho) View

  • Add title case validation for non-admonition sections in docstrings (by chrimaho) View

  • Add colon usage checks for admonition and non-admonition sections in docstrings (by chrimaho) View

  • Add blank lines after docstrings for improved readability (by chrimaho) View

  • Refactor SectionConfig() to enhance admonition validation and type handling (by chrimaho) View

  • Extend the core module to better handle edge-cases
    This will now throw errors when:

    1. When there is a section in a docstring which are not defined in the config
    2. When the admonition used in the docstring does not match the admonition defined in the config (by chrimaho) View

v0.2.0

v0.2.0 - Allow app to properly handle functions with @overload decorator🔗

🏷v0.2.0
📆2025-09-04
🔗data-science-extensions/docstring-format-checker/releases/v0.2.0

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/compare/v0.1.0...v0.2.0

Updates

v0.1.0

v0.1.0 - First Minor Release🔗

🏷v0.1.0
📆2025-08-31
🔗data-science-extensions/docstring-format-checker/releases/v0.1.0

Release Notes

What's Changed🔗

New Contributors🔗

Full Changelog: https://github.com/data-science-extensions/docstring-format-checker/commits/v0.1.0

Updates

  • Fix bug in CD workflow when building package (by chrimaho) View

  • Fix bugs in Git commit processes during CD workflow (by chrimaho) View

  • Fix bug (by chrimaho) View

  • Fix git command for coverage report (by chrimaho) View

  • Fix git commands (by chrimaho) View

  • Update Code Coverage info (by chrimaho) View

  • Ensure coverage report directory exists before copying files (by chrimaho) View

  • Streamline constants in the scripts module
    Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View

  • Fix failing unit tests for macos, caused by rm flags (by chrimaho) View

  • Enhance CLI test assertions for output flexibility and Windows compatibility (by chrimaho) View

  • Resolve failing unit tests on macos (by chrimaho) View

  • Fix failing unit tests (by chrimaho) View

  • Restructure unit tests to better handle temp files on the windows os (by chrimaho) View

  • Fix failing macos unit test (by chrimaho) View

  • Fix bug (by chrimaho) View

  • Fix configuration file path assertion in CLI tests (by chrimaho) View

  • Fix failing unit tests (by chrimaho) View

  • Update CI workflow to only run on Python versions 3.9 to 3.13 (by chrimaho) View

  • Refactor type hints in test_config.py for consistency and clarity (by chrimaho) View

  • Strip ANSI codes from all CliRunner output in unit tests (by chrimaho) View

  • Update pyupgrade pre-commit config to target Python 3.7 features (previously 3.9) (by chrimaho) View

  • Refactor all type hints to use Optional and Union instead of | for improved clarity, consistency, and compatability (by chrimaho) View

  • Add Python 3.7 to CI workflow matrix for enhanced compatibility (by chrimaho) View

  • Add detailed docstrings to all core modules (by chrimaho) View

  • Add strip_ansi_codes() function to generic Unit Tests setup and update CLI tests to use it for robust output validation (by chrimaho) View

  • Do more debugging in the CLI unit tests (by chrimaho) View

  • Add re to CLI unit tests (by chrimaho) View

  • Add strip_ansi_codes() function to the CLI Unit Tests (by chrimaho) View

  • Debug CLI Unit Test 19 (by chrimaho) View

  • Temporarily turn off pylint checks during pre-commit hooks (by chrimaho) View

  • Refactor CLI to use Typer imports directly and improve error messages (by chrimaho) View

  • Fix linting (by chrimaho) View

  • Remove redundant reference code (by chrimaho) View

  • Update CI and CD workflows to use specific script paths for running checks (by chrimaho) View

  • Fix CLI tests: Disable Rich colors to prevent ANSI formatting issues in CI

    • Set NO_COLOR=1 environment variable in CliRunner to ensure consistent test output
    • Resolves GitHub Actions test failures due to Rich library adding ANSI color codes
    • Local and CI environments now produce identical plain text error messages
    • All 175 tests now pass with 100% coverage in both local and CI environments (by chrimaho) View

  • Improve error message assertions for invalid recursive flag in CLI tests (by chrimaho) View

  • Add CD workflow along with scripts to bump version and generate changelog (by chrimaho) View

  • Fix typo (by chrimaho) View

  • Streamline automation scripts (by chrimaho) View

  • Add CI workflow (by chrimaho) View

  • Fix hardcoding in the Unit Tests



Hardcoded absolute path used in test. The cwd parameter contains a hardcoded personal directory path that will not work on other systems. This should use a relative path or be made configurable.
Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View

    * Add a nice README (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/6db7b02cf00e7e931170055c30e17f2b3a48beda)

    * Fix a typo (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/af7ac2cfa65570f0247195f19ce46d27a8f6e8eb)

    * Add docs structure and config (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/44d4d04063ea3b21d4f7fc9266973ba0294baada)

    * Add project guidelines (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/779197007301f3ee9fa8f997a0f39d577b096482)

    * Refactor exception handling: rename exceptions for clarity and consistency (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/864f6021a25d165e50da7f4c5791e4922645797a)

    * Remove `check-docstrings` from the `pre-commit` checks (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/f80b83a6cdcf156058218981fa3bc1f9d310659d)

    * Fix failing Unit Tests (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/ec53fa70fe4c524ced0c05646b742e31ebc1415f)

    * Clarify some of the `raise` sections to instead use Exceptions defined in the local module, instead of the default Exceptions from the builtins module (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/0719d8e11d3da4ed40d131d19ff2d61ceb494f14)

    * Refine any sections which use the `/` operator to merge objects in the `Path` package to instead use the `.joinpath()` method. This is to make the code more robust and more readable. (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/cffa310c67ac19aca060b74f5d9616262f89140a)

    * Correct and refine some of the docstrings in the `config` and `core` modules (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/8921f24d6096d5193ed5f4326cdbd41769b3a752)

    * Add new `_validate_config_order()` function to the `config` module (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/98a2409976dec6daebe4d007ec3c14a0267cbfea)

    * Refine how the `import`'s and `export`'s are defined across both the `cli` and `config` modules (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/f711ac7df7adc2d27f251238dcc84c551c8b4c8d)

    * Restructure how the `VALID_TYPES` constant is defined and utilised in the `config` module (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/6cdc073a2c089ac4253102b9d176566b6d81e1f1)

    * Add helpful docstrings and additional headers to the `cli` and `config` modules (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/5e9869a0612fb51eb072afe439554c3355f3bee9)

    * Refactor the Callbacks in the `cli` module to have better structure and organisation (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/5e227ec35cc69cddcd4b6be244a7241ea1066112)

    * Reorder the steps for the checks scripts (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/22286e4be755a13499b3cac7a06ad26910622dd8)

    * Add new exception classes for improved clarity and organization (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/07799214a39c33aa82559b5df846f49cb68e778b)

    * Bring code coverage for all unit tests up to 100% coverage (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/12aa070a8d220781789a7618d7a5e65510475a4b)

    * Update dependencies and refine project configuration in `pyproject.toml` (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/d98ed78b8cf46b25d647f15c41b58efa4accc49e)

    * Initial commit of all package unit tests (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/7331f758dcd4707af4a24065a81c2751a19fe0d6)

    * Initial commit of all package modules (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/91493ee736bdbf4c840b523fcfeb7d5940e6a15c)

    * Add utility scripts for command execution and linting checks (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/609e9cb37b1f5d68a0dd0970cce8cf3e5c6092ce)

    * Fix typo (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/4c0e003d2226a19a8f0596f821f5ca8c9feafa7b)

    * Tweak some of the core package config (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/7d870ad6959ed15496b74615b91517c1697fb4ff)

    * Initial commit of package config (by []()) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/32acad04208e5ac6302e261dcd5f76f7b09d61a1)

    * Initial commit (by [chrimaho](https://github.com/chrimaho)) [View](https://github.com/data-science-extensions/docstring-format-checker/commit/416b0b36cf5c4615295a7464a1544911aaa253d5)