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
12 changes: 12 additions & 0 deletions BREAKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

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

## [0.19.4-beta] - unreleased

### No Breaking Changes

This release is documentation-only. The `plot!` / `Makie.plot` / `Makie.plot!` docstrings
in the plotting extensions no longer cross-reference the public method with an `@extref`
anchor that cannot resolve — the public `Plots.plot` / `Makie.plot` methods on a `Solution`
live in weak-dependency extensions, so only the internal `_plot` helpers are in the
inventory ([#427](https://github.com/control-toolbox/CTModels.jl/issues/427), follow-on to
[#416](https://github.com/control-toolbox/CTModels.jl/issues/416)). The links are now plain
prose. No runtime behavior or public API changed; no migration required.

## [0.19.3-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.4-beta] - unreleased

### 📚 Documentation

- **Drop unresolvable `@extref` in the plotting-extension docstrings**
([#427](https://github.com/control-toolbox/CTModels.jl/issues/427)). The `plot!` /
`Makie.plot` / `Makie.plot!` docstrings cross-referenced the public method as
`` [`Plots.plot(::CTModels.Solutions.Solution)`](@extref) ``, an anchor that cannot
exist: the public `Plots.plot` / `Makie.plot` methods on a `Solution` are defined in
weak-dependency extensions, so the inventory registers only the internal
`CTModelsPlots._plot` / `CTModelsMakie._plot` helpers. The links are now plain prose.
This also clears four `@extref` warnings from OptimalControl.jl's docs build, where
these docstrings are transcluded. Follow-on to
[#416](https://github.com/control-toolbox/CTModels.jl/issues/416).

### ✅ Compatibility

- **No breaking changes**: documentation sources only; no runtime behavior, public API,
or migration is affected.

## [0.19.3-beta] - unreleased

### 📚 Documentation
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.3-beta"
version = "0.19.4-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 @@ -76,7 +76,7 @@ $(TYPEDSIGNATURES)
Plot the components of an optimal control [`CTModels.Solutions.Solution`](@extref) with a
Makie backend.

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

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

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

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