Skip to content

Document public API coverage#109

Merged
ChrisRackauckas merged 2 commits into
SciML:mainfrom
ChrisRackauckas-Claude:audit-public-api-docs
Jul 8, 2026
Merged

Document public API coverage#109
ChrisRackauckas merged 2 commits into
SciML:mainfrom
ChrisRackauckas-Claude:audit-public-api-docs

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

This PR should be ignored until reviewed by @ChrisRackauckas.

Summary

  • Attach docstrings to public/exported APIs whose existing documentation blocks were not attached or missing.
  • Render CorleoneOED API docs alongside the main Corleone API page.
  • Add docstrings for benchmark helper exports.

Local verification

  • git diff --check
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 -e 'using Runic; exit(Runic.main(ARGS))' -- --check .\n- timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=. -e 'using Pkg; Pkg.test()'\n- timeout 3600 env GROUP=CorleoneOED /home/crackauc/.juliaup/bin/julia +1.10 --project=. -e 'using Pkg; Pkg.test()'\n- timeout 3600 env GROUP=OptimalControlBenchmarks /home/crackauc/.juliaup/bin/julia +1.10 --project=. -e 'using Pkg; Pkg.test()'\n- timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=docs -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path=joinpath(pwd(), "lib", "CorleoneOED"))]); Pkg.instantiate(); include("docs/make.jl")'\n- Public doc metadata checks for Corleone, CorleoneOED, and OptimalControlBenchmarks all reported missing docs: Symbol[].\n\nDocumenter emitted warnings about an existing citation urldate without url, navbar repo detection, and generated HTML/search index size warnings.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor Author

Scope correction follow-up pushed in 37ad79b.

I re-audited explicit export declarations in:

  • Corleone: 12 exported names, missing docs: Symbol[]
  • CorleoneOED: 13 exported names, missing docs: Symbol[]
  • OptimalControlBenchmarks: 2 exported names, missing docs: Symbol[]

I also added OptimalControlBenchmarks to docs/Project.toml, docs/make.jl, and docs/src/api.md so its exported names are rendered via @autodocs, matching the corrected scope.

Additional local verification after the follow-up:

  • timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=docs -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path=joinpath(pwd(), "lib", "CorleoneOED")), PackageSpec(path=joinpath(pwd(), "lib", "OptimalControlBenchmarks"))]); Pkg.instantiate(); using Corleone, CorleoneOED, OptimalControlBenchmarks; ...' reported missing docs: Symbol[] for all explicit exports.\n- timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 -e 'using Runic; exit(Runic.main(ARGS))' -- --check . passed.\n- git diff --check passed.\n- timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=docs -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path=joinpath(pwd(), "lib", "CorleoneOED")), PackageSpec(path=joinpath(pwd(), "lib", "OptimalControlBenchmarks"))]); Pkg.instantiate(); include("docs/make.jl")' passed with the same non-fatal Documenter warnings as before.

@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review July 8, 2026 11:26
@ChrisRackauckas ChrisRackauckas merged commit fd49949 into SciML:main Jul 8, 2026
27 of 28 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