docs: clarify nonlinear solver cache interfaces - #1187
Merged
ChrisRackauckas merged 4 commits intoAug 22, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
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 until reviewed by @ChrisRackauckas.
The iterator tutorial now documents both valid
initcache forms: stepping caches andNonlinearSolveNoInitCachefor algorithms withoutSciMLBase.__init. It shows the genericsolve!fallback and adds a test covering the public cache classification for allSimpleNonlinearSolvealgorithms. This is docs/API guidance only and does not overlap termination documentation or PR #1179.Verification
GROUP=Core /home/crackauc/.juliaup/bin/julia +1.10 --project=. -e "using Pkg; Pkg.test()"->Testing NonlinearSolve tests passedGROUP=QA /home/crackauc/.juliaup/bin/julia +1.10 --startup-file=no --project=. -e "using Pkg; Pkg.test()"->QA | 26 | 26;Testing NonlinearSolve tests passed/home/crackauc/.juliaup/bin/julia +1.10 --project=docs docs/make.jl-> exit 0; doctests, cross-references, and HTML rendering completedtypos docs/src/tutorials/iterator_interface.md test/Core/core_tests__item13.jl-> exit 0git diff --check-> exit 0The repository formatter was not available locally: the installed
runicis a workspace-agent CLI without a check command, andJuliaFormatteris not in the project environment. Existing Documenter warnings about unrelated missing docstrings and HTML size remain unchanged.**Follow-up commit **
The cache-interface docs are now attached to the original definitions in and use SciMLStyle sections for fields, arguments, keywords, returns, extension rules, and examples. This is documentation-only; solver behavior and test logic are unchanged.
Additional verification:
The current full docs build was started after this commit and reached doctests and template expansion without an error, then was interrupted to avoid waiting on the broad render. It is not claimed as passed here. The prior PR-head docs build recorded above was green.
Follow-up commit 84c0bc2
The cache-interface docs are now attached to the original definitions in NonlinearSolveBase and use SciMLStyle sections for fields, arguments, keywords, returns, extension rules, and examples. This is documentation-only; solver behavior and test logic are unchanged.
Additional verification:
The current full docs build was started after this commit and reached doctests and template expansion without an error, then was interrupted to avoid waiting on the broad render. It is not claimed as passed here. The prior PR-head docs build recorded above was green.
Final strict verification
Follow-up commit: 6bcca08
Docs command: timeout 3600 julia --startup-file=no --project=docs docs/make.jl. Exit code 0. Documenter completed doctests, cross-reference checks, checkdocs, rendering, and linkcheck. Only non-fatal HTML-size, SVG fallback, headless-GKS, and deployment-environment warnings remained.
QA command: GROUP=QA timeout 3600 julia --startup-file=no --project=. -e using Pkg; Pkg.test(). Exit code 0. QA passed 28/28 in 59.7s on Julia 1.12.4, followed by Testing NonlinearSolve tests passed.
Core focused tests passed with Testing NonlinearSolve tests passed.
Runic checks pass for all touched Julia files. Typos and git diff --check pass.
The docs build remains strict: no warnonly, doctest suppression, external-link ignore, or QA ignore was added. The final source/docs diff only fixes owner references and adds the generic cache-interface test; no solver behavior changes were made.