Skip to content

Extension docstrings self-reference CTModels.Solution, but the inventory anchor is CTModels.Solutions.Solution #416

Description

@ocots

What

CTModels.jl:51 does a bare using .Solutions, which makes CTModels.Solution and CTModels.Solutions.Solution the same binding and both compile — but Documenter's inventory registers only the canonical path, CTModels.Solutions.Solution (that's where the type is actually defined). Several extension docstrings self-reference the short, flattened form instead, so any consumer's @extref/InterLinks-style cross-reference to them fails to resolve.

Surfaced while diagnosing OptimalControl's docs/make.jl warnonly backlog (control-toolbox/OptimalControl.jl, Phase D of the documentation campaign): four cannot resolve external link: Cannot find "\CTModels.Solution`"/"`Plots.plot(::CTModels.Solution)`"errors on OptimalControl'sresults/plot.mdandapi/io.md`.

Where

(The Makie ext isn't reachable by OptimalControl's current [compat] yet — CTModels 0.18 — but will hit the same failure once that unblocks, tracked separately as control-toolbox/CTDirect.jl#629.)

Suggested fix

Change the self-references from `CTModels.Solution` to `CTModels.Solutions.Solution` (or the equivalent @extref/@ref form CTModels' own docs use elsewhere) in all five spots.

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions