Fix FBDMD documentation cross-reference - #675
Conversation
Mark DMDSVD as a code reference so Documenter resolves it as a docstring rather than a header. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: OpenAI Codex <noreply@openai.com> Agent-Harness: Codex CLI 0.151.0 Agent-Model: gpt-5.6-sol Agent-Session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d
42906d8 to
7b9f463
Compare
|
Hosted docs reached a separate current-master linkcheck failure after the code-reference fix: the unchanged |
|
The complete documentation build now passes locally on this PR's unchanged source tree ( The failed CI job terminated on a 404 from the pinned Exact command from the checkout, Julia 1.12.7: TMPDIR=/home/crackauc/sandbox/tmp_20260831_204216_89854/.tmp JULIA_PKG_PRECOMPILE_AUTO=0 timeout 14400 /home/crackauc/.julia/juliaup/julia-1.12.7+0.x64.linux.gnu/bin/julia --project=docs docs/make.jlThe process exited 0. Terminal output includes: Redirect and large-example rendering warnings were also emitted and were not suppressed. The build's equivalent absolute-path rewrites in docs/Project.toml were restored afterward; the tracked worktree is clean. Local deployment was not performed or verified. The CI retry request was rejected with Links:
🤖 Validation coordinated with Codex CLI 0.153.4 (model: gpt-6-astra; session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d). |
Summary
Documenter 1.18 tightened
@refsyntax so plain link text targets headings and code-form link text targets docstrings. MarkDMDSVDas code in theFBDMDdocstring so strict cross-reference validation resolves the documented type again, without changing Documenter settings.Root cause
The failing workflow upgraded from Documenter 1.17.0 to 1.18.0. A minimized strict-docs
git bisectidentified JuliaDocs/Documenter.jl commit16a8cdcb32c6dd79bb2b045c41108d6e3ad39943, which intentionally made[Name](@ref)a heading reference and[`Name`](@ref)a docstring reference. The staleFBDMDdocstring used the former syntax for theDMDSVDtype.No separate runtime test was added: the strict documentation build is the exact discriminating regression test, and runtime behavior is unchanged.
Failing before
On unmodified
masteratd3325ea95ac70812e6a004e8e63020e0f31e7aff:This reproduces the failure in https://github.com/SciML/DataDrivenDiffEq.jl/actions/runs/33438015785/job/99639084750.
Passing after
The same command with this one-line source fix, using Julia 1.12.6 and Documenter 1.19.0:
The process exited successfully; local deployment was skipped as expected.
Verification
GPU and downstream jobs were not run because this is a documentation-link syntax correction with no runtime code change.
Links
🤖 Generated with Codex CLI 0.151.0 (model: gpt-5.6-sol; session: local session ID 01a0598f-11b9-72d1-91d9-b2fbb186557d).