Document public API coverage - #1255
Merged
ChrisRackauckas merged 8 commits intoJul 12, 2026
Merged
Conversation
Add source docstrings and rendered docs entries for public Optimization API names across backend packages. Add QA coverage for public/exported API docstrings and docs entries. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Remove the copied public API docs scanner from Optimization QA and configure SciMLTesting's built-in api_docs check with explicit ignores for external reexports that this repo does not own. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas-Claude
force-pushed
the
agent/public-doc-audit
branch
from
July 11, 2026 23:32
3207844 to
206aa46
Compare
Add gradient_sampling_subsolver! to the OptimizationManopt API docs QA ignore list because it is reexported from Manopt and is not owned by OptimizationManopt. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
SciMLTesting develops the package under test before running the QA group, so the QA project does not need a self `[sources]` path entry. Removing it avoids leaking local checkout paths into the PR. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas
marked this pull request as ready for review
July 12, 2026 07:21
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
2 participants
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 until reviewed by @ChrisRackauckas.
Summary:
Verification: