Skip to content

Document output saving public APIs#321

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/public-api-doc-audit
Jul 8, 2026
Merged

Document output saving public APIs#321
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/public-api-doc-audit

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

Ignore until reviewed by @ChrisRackauckas.

Summary

  • Add missing rendered docs entries for SavedValues, IndependentlyLinearizedSolution, and LinearizingSavingCallback on the output-saving docs page.
  • Expand source docstrings for the same output-saving storage/linearization APIs with signatures, arguments, returns, and examples.

Audit

  • Export/public declaration search found exports only; no public, Expr(:public), or @public declarations.
  • Mechanical audit reports no exported names missing doc bindings.
  • Mechanical docs-page audit reports no exported names missing rendered @docs entries.

Local verification

  • timeout 3600 julia --project=. -m Runic --inplace src/saving.jl src/independentlylinearizedutils.jl
  • timeout 3600 julia --project=. -m Runic --check .
  • timeout 3600 julia --project=. -e 'using Pkg; Pkg.test()' passed.\n- timeout 3600 julia --project=docs docs/make.jl timed out in Documenter.HTMLWriter.render after document checks and HTML rendering had started.\n- A targeted output-saving Documenter build with edit links disabled also timed out in Documenter.HTMLWriter.render after document checks.\n

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review July 8, 2026 11:13
@ChrisRackauckas ChrisRackauckas merged commit 4305a5a into SciML:master Jul 8, 2026
18 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