Skip to content

Document Sundials public API#545

Draft
ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/sundials-public-doc-audit
Draft

Document Sundials public API#545
ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/sundials-public-doc-audit

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

This PR should be ignored until reviewed by @ChrisRackauckas.

Summary

  • Add source-site docstrings for the Sundials-owned exported abstract algorithm supertypes.
  • Add a minimal Documenter docs tree with @docs entries for the declared public/exported Sundials API.
  • Add focused QA coverage that scans source export/public/@public/SciMLPublic.@public declarations, verifies source-site docstrings, and verifies rendered docs entries.

Validation

  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_sundials /home/crackauc/.juliaup/bin/julia +release --project=/home/crackauc/sandbox/tmp_20260708_051717_3275/.runic_env -m Runic -i src/common_interface/algorithms.jl test/qa/qa.jl test/qa/public_api_docs.jl docs/make.jl
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_sundials /home/crackauc/.juliaup/bin/julia +release --project=/home/crackauc/sandbox/tmp_20260708_051717_3275/.runic_env -m Runic --check src/common_interface/algorithms.jl test/qa/qa.jl test/qa/public_api_docs.jl docs/make.jl
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_sundials /home/crackauc/.juliaup/bin/julia +1.10 --project=test/qa -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate(); include("test/qa/qa.jl")'
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_sundials /home/crackauc/.juliaup/bin/julia +1.10 --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate(); include("docs/make.jl")'
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_sundials /home/crackauc/.juliaup/bin/julia +1.10 --project=. -e 'using Pkg; Pkg.test()'

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
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