Render ConvergenceTrajectory in package docs - #4312
Merged
ChrisRackauckas merged 1 commit intoAug 20, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
CI triage: all completed failures are the two independently reproduced master Downstream issues. ProbNumDiffEq’s Julia 1.10 resolver failure is addressed by #4320. PositiveIntegrators’ LinearSolve 5 compatibility failure is addressed upstream by NumericalMathematics/PositiveIntegrators.jl#216. No completed red check currently points to this PR’s changed behavior. |
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.
Please ignore this PR until reviewed by @ChrisRackauckas.
What changed and why
Add the exported
ConvergenceTrajectorytype to DiffEqDevTools' package-local rendered API page. The root OrdinaryDiffEq docs already rendered its docstring, but DiffEqDevTools QA deliberately checkslib/DiffEqDevTools/docs/src; the type was therefore public and documented yet still failed the package's rendered-doc assertion.An independent bisect identified 528f821 as the first bad commit. That change introduced and exported the type but added it only to the root docs tree.
Failing before / passing after
Before this entry:
With this patch, the focused check passes:
Local verification
SciMLTesting.run_api_docspackage check: 2/2 passed after failing on the unfixed docs tree.julia +1.12 --startup-file=no --project=docs docs/make.jl: completed successfully and rendered the full documentation site.--check --docstrings,typos, andgit diff --check: passed.The complete package QA group still encounters the independent Aqua persistent-task failure present on master. A proposed version-only workaround was tested with fresh before/after cache controls, failed identically, and was closed at #4311. This PR fixes the rendered-doc assertion only. GPU, downstream, and prerelease-Julia groups were not run because this changes documentation only.