Fix fatal docs cross-reference: include NonstructuralZeros docstrings - #1026
Merged
ChrisRackauckas merged 1 commit intoJun 10, 2026
Merged
Conversation
The OperatorAssumptions docstring links [`NonstructuralZeros`](@ref), but the NonstructuralZeros enum docstring was never included in any @docs block, so makedocs failed with a fatal :cross_references error on the OperatorAssumptions page. Add NonstructuralZeros and its variant docstrings to docs/src/basics/OperatorAssumptions.md, mirroring the OperatorCondition layout. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
This was referenced Jun 10, 2026
ChrisRackauckas
marked this pull request as ready for review
June 10, 2026 08:59
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
3 participants
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.
Please ignore until reviewed by @ChrisRackauckas.
Problem
The Documentation workflow fails on
mainwith:Introduced by cdb6f77 (#1017), which added the
NonstructuralZerosenum whose@refis linked from theOperatorAssumptionsdocstring, without including theNonstructuralZerosdocstring in any@docsblock.Fix
Add
NonstructuralZerosto the@docsblock indocs/src/basics/OperatorAssumptions.md, plus a "Nonstructural Zero Specifications" section with the four variant docstrings (Auto/None/Persistent/Present), mirroring the existingOperatorConditionlayout.Verification
Reproduced the failure locally on unmodified
main(docs env withPkg.developof the parent + LinearSolveAutotune,julia docs/make.jl): same fatal:cross_referenceserror. With this change the build completes and renders successfully; remaining warnings (:docs_block,:missing_docs, including theSciMLBase.*docstrings) are pre-existing and covered bywarnonly.🤖 Generated with Claude Code