Fix ImplicitDiscreteSolve API docs QA#3969
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
Draft
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Commit Investigation record:
Local validation after the commit:
|
Member
Author
|
Relevant CI is green:
The overall PR remains
Neither failure exercises the changed ImplicitDiscreteSolve QA file. |
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.
Ignore this PR until reviewed by @ChrisRackauckas.
Summary
IDSolveis documented.Root cause
git bisectidentified12b6996e27(Update SciMLTesting QA docs coverage (#3867)) as the first bad commit. That change moved the QA environment to SciMLTesting 2.x, whoserun_qachecks rendered public API by default.ImplicitDiscreteSolve has no package-local
docs/src; its documentation lives in the monorepo's rootdocs/src. On Julia 1.10, the failed check therefore compared an empty documentation tree against 186 exported names: 185 SciMLBase reexports plus the package-ownedIDSolve. The root manual already rendersIDSolveindocs/src/misc.md.The fix keeps the rendering assertion active for package-owned API. It only delegates SciMLBase reexports to their owner.
Validation
ODEDIFFEQ_TEST_GROUP=QA julia +1.10 --project=lib/ImplicitDiscreteSolve -e 'using Pkg; Pkg.test()'Pkg.test()exited successfullyjulia +1.12 --project=<local Runic environment> -m Runic --check lib/ImplicitDiscreteSolve/test/qa/qa.jlpassed with Runic 1.7.0.git diff --checkpassed.For the bisect's good side,
d7a66c0fe4resolved SciMLTesting 1.8 and passed JET 1/1 plus Aqua 15/15. The first-bad commit reproduced the rendered-docs failure with 16 passes and 1 failure.An additional Julia 1.12 run was blocked before this QA file loaded by a separate package-source resolution error for
OrdinaryDiffEqCore's relativeDiffEqBasesource. That baseline is being investigated separately.