Document public Integrals APIs#343
Merged
ChrisRackauckas merged 1 commit intoJul 10, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas-Claude
force-pushed
the
docs/public-api-doc-coverage
branch
from
July 10, 2026 18:15
c4f9296 to
ad5555c
Compare
ChrisRackauckas
marked this pull request as ready for review
July 10, 2026 18:28
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
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.
Summary
This PR documents the Integrals-owned public API surface and adds a QA guard that requires exported public bindings to have both source docstrings and rendered docs entries.
Please ignore this PR until it has been reviewed by @ChrisRackauckas.
Changes
@docscoverage.Validation
git diff --check origin/master...HEADjulia +release --startup-file=no --project=. -e 'using Pkg; Pkg.instantiate(); using Runic; exit(Runic.main(["--check", "."]))'julia +release --startup-file=no --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("docs/make.jl")'GROUP=QA julia +release --startup-file=no --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.test()'GROUP=Core julia +release --startup-file=no --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.test()'julia +1.10 --startup-file=no --project=test/AD -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("test/AD/derivative_tests.jl"); include("test/AD/nested_ad_tests.jl")'The root
Pkg.test()on Julia release was also attempted first, but it timed out in the AD group because the root test harness runs all groups;test/test_groups.tomlonly runs AD on LTS, so the final validation above uses the CI-aligned groups/channels.