Skip to content

Commit 1eb6912

Browse files
Update changelog to v1.11.2 [skip ci]
1 parent 8836fc1 commit 1eb6912

1 file changed

Lines changed: 78 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,84 @@
99
.md-nav--secondary .md-nav__list .md-nav__list { display: none; }
1010
</style>
1111

12+
!!! info "v1.11.2"
13+
14+
## **v1.11.2 - Doctest Utilities and Configuration Refinement**
15+
16+
<!-- md:tag v1.11.2 --><br>
17+
<!-- md:date 2026-01-14 --><br>
18+
<!-- md:link [data-science-extensions/docstring-format-checker/releases/v1.11.2](https://github.com/data-science-extensions/docstring-format-checker/releases/tag/v1.11.2) -->
19+
20+
??? note "Release Notes"
21+
22+
### 📃 Overview
23+
24+
Introduce new utility functions for executing doctests and refine the configuration loading process to better handle unordered sections. This release also standardises documentation metadata and improves the reliability of the coverage reporting workflow.
25+
26+
27+
### ✨ New Features
28+
29+
30+
#### 🔍 Integrate Doctest Checking Functions
31+
32+
Introduce automated doctest execution to verify code examples within docstrings.
33+
34+
- Implement the `check_doctest()` function in `src/utils/scripts.py` to run doctests across all Python files in the package.
35+
- Implement the `check_doctest_module()` function to target specific modules for doctest validation.
36+
- Implement the `check_doctest_cli()` function to provide a command-line interface for module-specific doctest checking.
37+
38+
39+
### 🐛 Bug Fixes
40+
41+
42+
#### ⚙️ Refine Configuration Order Validation
43+
44+
Resolve an issue where multiple sections without an explicit order value caused duplicate key errors.
45+
46+
- Update the `SectionConfig()` class to consistently allow `None` for the `order` attribute.
47+
- Update the `_parse_sections_config()` function in `config.py` to remove the default value of `0` when extracting `order` from configuration data.
48+
- Ensure that sections without an explicit order are correctly sorted to the end of the validation sequence.
49+
50+
51+
### ⚙️ Technical Improvements
52+
53+
54+
#### 🚀 Enhance Project Workflow
55+
56+
Improve the robustness of the development and documentation workflows.
57+
58+
- Update the `git_add_coverage_report()` function to use the `--force` flag when adding the coverage report directory, ensuring reports are captured regardless of ignore rules.
59+
- Fix typographical errors and standardise the project title to `docstring-format-checker` across documentation files.
60+
- Refine the documentation home page to use a dedicated `coverpage_icon_source` variable in `mkdocs.yaml` for better maintainability.
61+
62+
63+
### 💪 Pull Requests
64+
65+
* Enhance Configuration Handling for non-Ordered Sections by @chrimaho in https://github.com/data-science-extensions/docstring-format-checker/pull/37
66+
67+
68+
**Full Changelog**: https://github.com/data-science-extensions/docstring-format-checker/compare/v1.11.1...v1.11.2
69+
70+
??? abstract "Updates"
71+
72+
* [`3a64287`](https://github.com/data-science-extensions/docstring-format-checker/commit/3a64287cfb6b579b641920d676e82407fef9557f): Add doctest checking functions<br>
73+
- Introduce `check_doctest()` function to run doctest on all Python files.<br>
74+
- Introduce `check_doctest_module(module_name: str)` function to run doctest on a specific module.<br>
75+
- Introduce `check_doctest_cli()` function to handle command line interface for doctest checking.
76+
(by [chrimaho](https://github.com/chrimaho))
77+
* [`c34fa7d`](https://github.com/data-science-extensions/docstring-format-checker/commit/c34fa7df275ba3e5d5fe07f8f261425d4610f0cb): Fix typos
78+
(by [chrimaho](https://github.com/chrimaho))
79+
* [`dd78484`](https://github.com/data-science-extensions/docstring-format-checker/commit/dd78484daf2503da93c1ceca364f73a5bfa772e0): Refine section order handling in configuration loading<br>
80+
- Update `order` assignment in `SectionConfig` to allow None values.<br>
81+
- Add tests for loading configurations with multiple sections without order.<br>
82+
- Implement test for handling explicit duplicate order values.
83+
(by [chrimaho](https://github.com/chrimaho))
84+
* [`ca6646e`](https://github.com/data-science-extensions/docstring-format-checker/commit/ca6646ed424104752156b64a36cf15204e7f9ad9): Force git to add coverage report during CD workflow<br>
85+
- Update the command to force add the coverage report directory using `git add ./docs/code/coverage/ --force`<br>
86+
- Ensure the coverage report is committed without verification
87+
(by [chrimaho](https://github.com/chrimaho))
88+
89+
1290
!!! info "v1.11.1"
1391

1492
## **v1.11.1 - Static Type Checking and Robust Sorting**

0 commit comments

Comments
 (0)