docs: drop unresolvable @extref in plotting-extension docstrings (#427) - #428
Merged
Merged
Conversation
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. Also clears four `@extref` warnings from OptimalControl.jl's docs build, where these docstrings are transcluded onto results/plot.md, results/plot-makie.md and the generated api/io.md. Follow-on to #416. Documentation-only; no runtime or public-API change. Bumps to 0.19.4-beta. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ocots
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #427.
Problem
Three docstrings in the plotting extensions cross-reference the public plotting method
by signature:
ext/CTModelsPlots.jl:128—Plots.plot!docstringext/CTModelsMakie.jl:79—Makie.plotdocstringext/CTModelsMakie.jl:100—Makie.plot!docstringNone resolve.
Plots.plot(::CTModels.Solution)/Makie.plot(::CTModels.Solution)aredefined in weak-dependency extensions, so they are not part of any package the
InterLinks inventory indexes.
objects.inv(local build, publishedstable, publisheddev— all checked) registers onlyCTModelsPlots._plot/_plot!,CTModelsMakie._plot/_plot!,CTModels.PlotCase.*andCTModels.Solutions.Solution jl:type. There is noPlots.plot/Makie.plotbinding to anchor to.Residue of #416, which fixed the type path (
CTModels.Solution→CTModels.Solutions.Solution) but not thePlots.plot(::…)method self-reference.Fix
Drop the link, keep the prose — these docstrings only say "same keyword arguments as the
other plot method":
ext/CTModelsPlots.jl… keyword arguments asplot(documented above);ext/CTModelsMakie.jl(×2)… as the Plots-backendplot``The resolvable
[CTModels.Solutions.Solution](@extref)links are left untouched.Effect
@extreferrors from OptimalControl.jl's docs build (these docstrings aretranscluded onto
results/plot.md,results/plot-makie.mdand the generatedapi/io.md) — verified with a full OptimalControl docs build against this branch: the@extrefbacklog goes 6 → 2, and the remaining 2 are a separate OptimalControl-sidedocstring fixed in
_strategy_parameterdocstring@extrefsCTBase.Strategies.parameterwith a method signature the inventory does not index OptimalControl.jl#943.Documentation-only; no runtime or public-API change.
Project.tomlbumped to0.19.4-beta, CHANGELOG + BREAKING updated (No Breaking Changes).🤖 Generated with Claude Code