diff --git a/BREAKING.md b/BREAKING.md index b8b7d96c..678b91ae 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md index d3e5e327..ba61a4e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/Project.toml b/Project.toml index 36628834..2c7bce11 100644 --- a/Project.toml +++ b/Project.toml @@ -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 "] [deps] diff --git a/ext/CTModelsMakie.jl b/ext/CTModelsMakie.jl index 06bdbbd2..9cc90445 100644 --- a/ext/CTModelsMakie.jl +++ b/ext/CTModelsMakie.jl @@ -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`. @@ -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!( diff --git a/ext/CTModelsPlots.jl b/ext/CTModelsPlots.jl index fe41edc3..a4e30c1f 100644 --- a/ext/CTModelsPlots.jl +++ b/ext/CTModelsPlots.jl @@ -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`. @@ -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!(