Skip to content

DOCPCache referenced via @ref in two docstrings, but has no docstring of its own #630

Closed

Description

@ocots

What

Both direct_shooting.jl:119 and collocation.jl:115 document their return value as "...holding a DOCPCache with the precomputed DOCP." DOCPCache has no docstring anywhere in the repository, so the @ref can never resolve.

Surfaced while diagnosing OptimalControl's docs/make.jl warnonly backlog (control-toolbox/OptimalControl.jl, Phase D of the documentation campaign): both instances fire as Cannot resolve @ref for md"[\DOCPCache`](@ref)"on OptimalControl's generatedapi/solving.md, since direct_shooting/collocation`-backed functions are re-exported there.

Where

Suggested fix

Either:

  • add a docstring to DOCPCache and include it in CTDirect's own API reference (if it's meant to be a documented, if internal, type), or
  • de-qualify both references to plain, non-linked text (`DOCPCache` without [...](@ref)) if it's genuinely internal and not meant to be a link target.

🤖 Generated with Claude Code

Activity

  1. ocots commented on Aug 30, 2026

    @ocots
    MemberAuthor

    Verified in 1.1.4-beta — confirmed both ways:

    • The source: direct_shooting.jl:119 and collocation.jl:115 (well, CTSolvers.discretize's two per-strategy docstrings) now write plain `DOCPCache` instead of [`DOCPCache`](@ref).
    • The consumer build: rebuilt OptimalControl's docs against 1.1.4-beta — the two Cannot resolve @ref for md"[DOCPCache](@ref)" warnings on api/solving.md are gone (0/0, down from 2).

    Closing.

    🤖 Generated with Claude Code

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

Metadata

Metadata

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