Document umbrella re-exported API#3970
Merged
ChrisRackauckas merged 1 commit intoJul 20, 2026
Merged
Conversation
Render the common solve, problem, callback, utility, AD, and module interfaces exported by OrdinaryDiffEq so public API documentation QA covers the umbrella package. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas
marked this pull request as ready for review
July 20, 2026 21:29
This was referenced Jul 20, 2026
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.
Important
Please ignore this draft until it has been reviewed by @ChrisRackauckas.
Summary
Clean-master root cause
The exact global QA lane fails on clean master because SciMLTesting 2.3 enables rendered public-API checks by default. The umbrella module exported 33 common interface names, but none appeared in an @docs or @autodocs block.
A first-parent boundary check found commit d7a66c0 passing 6/6 immediately before merge commit 12b6996, while 5766b7c fails 7 passed / 1 failed with all 33 names. The boundary commit raised the SciMLTesting compatibility from 1.7 to 2.1, allowing the newly released 2.3 behavior.
Validation
The rendered page is 102.32 KiB, slightly above Documenter's 100 KiB warning threshold and below its 200 KiB hard threshold. No warning was disabled or added to warnonly.