Document StochasticDiffEqLevyArea public API#3967
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
Draft
Document StochasticDiffEqLevyArea public API#3967ChrisRackauckas-Claude wants to merge 1 commit into
ChrisRackauckas-Claude wants to merge 1 commit into
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Validation scratchpad for commit Clean-master reproduction and boundary
Final branch validationRun on Julia 1.12.6 after applying the focused patch to official master
The Documenter run retains the repository's existing warn-only documentation backlog; this patch does not add a missing/undefined binding warning for the new page. Base freshnessAfter PR creation, No SpecialFunctions compatibility changes are included in this PR. |
Member
Author
|
CI classification after the current runs:
The overall |
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
This PR should be ignored until reviewed by @ChrisRackauckas.
Summary
StochasticDiffEqLevyAreaRoot cause
SciMLTesting's public-API documentation check began running for this sublibrary in
12b6996e27ea4ea589a30cd4858cb8ecdd3ef446. The preceding commitd7a66c0fe4342a63de74d898d8ecaf64c8eef199passes QA 18/18, while12b6996fails with the same seven missing docstrings seen on current master:Fourier,FrobeniusL2,MaxL2,Milstein,MronRoe,Wiktorsson, andlevyarea.Those exports originated undocumented when the subpackage was added in
fdb6fdd2c66ccae2e807aafdb20890a55ceba080; the newer QA check exposed that latent gap.Impact
The StochasticDiffEqLevyArea QA lane passes without skips or exceptions, and users get rendered reference documentation for the sublibrary's algorithms, error norms, coefficients, and iterated-integral APIs.
This PR intentionally does not include the separate SpecialFunctions compatibility change.
Validation
Run locally on Julia 1.12.6 from current official master
38f01c5fa5cbe2efd164cd8463b4654e6fb305d1:git diff --check: passedProcess