Skip to content

Fix docs build: document CommonSolve.init in manual - #360

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:fix-docs-build
Aug 26, 2026
Merged

ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:fix-docs-build

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Summary

  • Documenter's checkdocs = :exports reports the reexported init docstrings under the CommonSolve.init binding, but the manual only referenced unqualified init(...).
  • Reference CommonSolve.init explicitly in the @docs block and import CommonSolve in docs/make.jl.

Root cause

After adopting strict checkdocs = :exports in #352, the Integrals-owned init docstrings were not matched to the exported CommonSolve.init binding, causing :missing_docs failures.

Test plan

  • Local docs build passes checkdocs = :exports (verified; linkcheck may rate-limit locally)
  • Documentation CI on this PR

Made with Cursor

Documenter checkdocs=:exports tracks reexported init under CommonSolve, so include those bindings explicitly in the manual.

Co-authored-by: Cursor <cursoragent@cursor.com>
@ChrisRackauckas
ChrisRackauckas merged commit 2dbd254 into SciML:master Aug 26, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants