Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions BREAKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

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

## [0.19.2-beta] - unreleased

### No Breaking Changes

The `@extref` targets in the `CTModelsPlots` and `CTModelsMakie` extension
docstrings now use the canonical `CTModels.Solutions.Solution` path
([#416](https://github.com/control-toolbox/CTModels.jl/issues/416)). This only
fixes documentation cross-reference resolution; runtime behavior and the public
API are unchanged, and no migration is required.

## [0.19.1-beta] - unreleased

### No Breaking Changes
Expand Down
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.19.2-beta] - unreleased

### 🔧 Fixed

- **Extension docstring cross-references**
([#416](https://github.com/control-toolbox/CTModels.jl/issues/416)). The
`CTModelsPlots` and `CTModelsMakie` extension docstrings now use the canonical
`CTModels.Solutions.Solution` path so their `@extref` links resolve in CTModels
and downstream documentation builds.

### 📚 Documentation

- Corrected the five plotting-extension `@extref` targets to match the
`objects.inv` inventory entry for `CTModels.Solutions.Solution`.

### ✅ Compatibility

- **No breaking changes**: this release only corrects documentation
cross-references; no runtime behavior, public API, or migration is affected.

## [0.19.1-beta] - unreleased

### ✨ Added
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "CTModels"
uuid = "34c4fa32-2049-4079-8329-de33c2a22e2d"
version = "0.19.1-beta"
version = "0.19.2-beta"
authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]

[deps]
Expand Down
6 changes: 3 additions & 3 deletions ext/CTModelsMakie.jl
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ end
"""
$(TYPEDSIGNATURES)

Plot the components of an optimal control [`CTModels.Solution`](@extref) with a
Plot the components of an optimal control [`CTModels.Solutions.Solution`](@extref) with a
Makie backend.

Same `description` and keyword arguments as [`Plots.plot(::CTModels.Solution)`](@extref)
Same `description` and keyword arguments as [`Plots.plot(::CTModels.Solutions.Solution)`](@extref)
(`layout`, `control`, `time`, the `*_style` / `*_bounds_style` keywords, `color`,
`size`). Returns a `Makie.Figure`.

Expand All @@ -97,7 +97,7 @@ end
$(TYPEDSIGNATURES)

Overlay the optimal control solution `sol` onto the existing `Makie.Figure` `f`. Same
behaviour and keyword arguments as [`Plots.plot(::CTModels.Solution)`](@extref); an
behaviour and keyword arguments as [`Plots.plot(::CTModels.Solutions.Solution)`](@extref); an
empty `f` is filled as if by `plot`.
"""
function Makie.plot!(
Expand Down
4 changes: 2 additions & 2 deletions ext/CTModelsPlots.jl
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ end
"""
$(TYPEDSIGNATURES)

Plot the components of an optimal control [`CTModels.Solution`](@extref).
Plot the components of an optimal control [`CTModels.Solutions.Solution`](@extref).

Generates a set of subplots showing the state, control, costate, path constraints and
dual variables over time, depending on the problem and the given `description`.
Expand Down Expand Up @@ -125,7 +125,7 @@ end
$(TYPEDSIGNATURES)

Overlay the optimal control solution `sol` onto the existing plot `p`. Same behaviour and
keyword arguments as [`Plots.plot(::CTModels.Solution)`](@extref); an empty `p` is filled as
keyword arguments as [`Plots.plot(::CTModels.Solutions.Solution)`](@extref); an empty `p` is filled as
if by `plot`.
"""
function Plots.plot!(
Expand Down
Loading