Skip to content

Commit f81e477

Browse files
committed
docs: add 0.8.3-beta changelog and breaking changes
- Document module renaming InitialGuess → Init - Document type renaming OptimalControlPreInit → PreInitialGuess - Add migration guide with code examples - Update breaking changes documentation - Include benefits and compatibility information
1 parent 87c24b3 commit f81e477

2 files changed

Lines changed: 95 additions & 0 deletions

File tree

BREAKING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,65 @@
22

33
This document describes breaking changes in CTModels releases and how to migrate your code.
44

5+
## [0.8.3-beta] - 2026-02-12
6+
7+
### Module and Type Renaming
8+
9+
#### Overview
10+
The InitialGuess module has been renamed to `Init` for better API ergonomics and more concise naming. This is a **breaking change** that requires users to update their imports and type references.
11+
12+
#### What Changed
13+
14+
##### Module Name
15+
```julia
16+
# Before (0.8.2-beta and earlier)
17+
using CTModels.InitialGuess
18+
19+
# After (0.8.3-beta)
20+
using CTModels.Init
21+
```
22+
23+
##### Type Names
24+
```julia
25+
# Before
26+
pre = CTModels.OptimalControlPreInit(...)
27+
abstract_type = CTModels.AbstractOptimalControlPreInit
28+
29+
# After
30+
pre = CTModels.PreInitialGuess(...)
31+
abstract_type = CTModels.AbstractPreInitialGuess
32+
```
33+
34+
#### Migration Required
35+
36+
**User code changes required** - update your imports and type references:
37+
38+
```julia
39+
# Before
40+
using CTModels.InitialGuess
41+
pre_init = CTModels.OptimalControlPreInit(state=0.1, control=0.2)
42+
43+
# After
44+
using CTModels.Init
45+
pre_init = CTModels.PreInitialGuess(state=0.1, control=0.2)
46+
```
47+
48+
#### Benefits
49+
50+
- **More Concise API**: `CTModels.Init` vs `CTModels.InitialGuess`
51+
- **Cleaner Type Names**: `PreInitialGuess` vs `OptimalControlPreInit`
52+
- **Better Developer Experience**: Shorter, more intuitive names
53+
- **Maintained Functionality**: Zero behavioral changes, only naming improvements
54+
55+
#### Compatibility
56+
57+
- All public functions remain unchanged
58+
- Only module and type names have been updated
59+
- All tests pass (3146/3146)
60+
- Ready for production use
61+
62+
---
63+
564
## [0.8.2-beta] - 2026-02-12
665

766
### InitialGuess Validation Architecture Change

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,42 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.8.3-beta] - 2026-02-12
9+
10+
### Breaking
11+
12+
- **Module Renaming**: InitialGuess module renamed to Init for better API ergonomics
13+
- `InitialGuess` module → `Init` module
14+
- `OptimalControlPreInit` type → `PreInitialGuess` type
15+
- `AbstractOptimalControlPreInit` type → `AbstractPreInitialGuess` type
16+
- **Action Required**: Update imports and type references
17+
18+
### Changed
19+
20+
- **API Ergonomics**: Shorter, more intuitive module and type names
21+
- `CTModels.InitialGuess``CTModels.Init`
22+
- Improved developer experience with concise naming
23+
- Updated all documentation references
24+
25+
### Added
26+
27+
- **Module Organization**: Consolidated Init module structure
28+
- Reorganized under `src/Init/` directory
29+
- Updated exports and imports throughout codebase
30+
- All tests updated to use new naming (3146 tests passing)
31+
32+
### Migration Guide
33+
34+
```julia
35+
# Before
36+
using CTModels.InitialGuess
37+
pre = CTModels.OptimalControlPreInit(...)
38+
39+
# After
40+
using CTModels.Init
41+
pre = CTModels.PreInitialGuess(...)
42+
```
43+
844
## [0.8.2-beta] - 2026-02-12
945

1046
### Changed

0 commit comments

Comments
 (0)