Skip to content

Commit f3942a1

Browse files
committed
Scope MD024 disable to CHANGELOG.md and BREAKING.md only
Add <- Files: model/ (overview, types_and_traits, components, dynamics_objective, constraints, building), solution/ (overview, time_grids, trajectories, markdownlint-disable MD024 --> at top of CHANGELOG.md and BREAKING.md. Remove MD024 from global .markdownlint.json config so other markdown files still get checked for duplicate headings.
1 parent 732ba70 commit f3942a1

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

BREAKING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD024 -->
12
# Breaking Changes
23

34
This document outlines all breaking changes introduced in CTBase v0.18.0-beta compared to v0.17.4. Use this guide to migrate your code and understand the impact of these changes.

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD024 -->
12
# Changelog
23

34
All notable changes to CTBase will be documented in this file.
@@ -1122,6 +1123,7 @@ Strategies.default_parameter(::Type{<:MadNLP}) = Strategies.CPU
11221123
### 🚀 Major Features
11231124

11241125
#### **Modular Architecture Overhaul**
1126+
11251127
- **Complete reorganization** of the codebase into thematic modules:
11261128

11271129
```text
@@ -1270,23 +1272,27 @@ This major release represents a significant investment in code quality, develope
12701272
### 🚀 TestRunner Enhancements
12711273

12721274
#### **Advanced Progress Bar System**
1275+
12731276
- **Adaptive bar width**: Width equals total for ≤20 tests, fixed at 20 for >20 tests
12741277
- **Visual consistency**: Uses `` (filled) and `` (empty) characters without gaps
12751278
- **Smart failure detection**: Correctly detects both exceptions and `@test` assertion failures
12761279
- **Zero-padded indices**: Aligned test numbers for better readability
12771280

12781281
#### **Robust Failure Detection**
1282+
12791283
- **Before/after results scanning**: Compares testset results before and after eval
12801284
- **Recursive failure detection**: Scans nested testsets for `Test.Fail` and `Test.Error`
12811285
- **More reliable than `anynonpass`**: Works regardless of testset completion timing
12821286

12831287
#### **Enhanced User Experience**
1288+
12841289
- **Path prefix stripping**: Users can write `test/suite` or `suite` interchangeably
12851290
- **Guard against conflicts**: Prevents `test/` subdirectory in test directory
12861291
- **Comprehensive callbacks**: `on_test_start` and `on_test_done` with `TestRunInfo` context
12871292
- **Configurable progress**: Built-in progress bar with option for custom callbacks
12881293

12891294
#### **Professional Documentation**
1295+
12901296
- **Complete docstring overhaul**: All functions follow project documentation standards
12911297
- **Safe, runnable examples**: All examples use `julia-repl` with proper imports
12921298
- **Cross-reference resolution**: Fully qualified `@ref` links to prevent header conflicts
@@ -1295,6 +1301,7 @@ This major release represents a significant investment in code quality, develope
12951301
### 📈 Documentation Improvements
12961302

12971303
#### **Better Organization**
1304+
12981305
- **User guides in `src/guide/`**: Clear separation from API reference
12991306
- **API reference in `src/api/`**: Auto-generated with clean filenames
13001307
- **Updated navigation**: Changed "Tutorials" to "User Guides" for clarity

0 commit comments

Comments
 (0)