Document remaining SciMLBase public API helpers#1423
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
Draft
Document remaining SciMLBase public API helpers#1423ChrisRackauckas-Claude wants to merge 1 commit into
ChrisRackauckas-Claude wants to merge 1 commit into
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ddafcf3 to
224e197
Compare
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.
Summary
This is a focused follow-up to the SciMLBase public API documentation audit. It documents a set of SciMLBase-owned exported/public helper APIs at their source definitions and adds them to rendered interface docs.
Please ignore this PR until reviewed by @ChrisRackauckas.
Changes
@docsentries for public helper/stub APIs:discretize,symbolic_discretizeClocks,TimeDomainget_dt,set_abstol!,set_reltol!,u_modified!,addsteps!AllObserved,SteadyStateSolution,QuadratureSolutioncheck_keywordsu_modified!macro form with an explicit deprecated method so the binding can carry a normal source docstring while preserving the deprecation warning behavior.@docattachment forAlgorithmInterpretation; the enum source docstring still resolves, and this removes the duplicate-doc precompile warning.Audit notes
Audit method:
names(SciMLBase; all=false)withBase.ispublic/Base.isexported.Docs.metabindings for the fixed names and checked rendered@docsentries indocs/src.Remaining audit candidates not handled in this focused PR are mostly dependency reexports/imported bindings (
SciMLOperators.*,CommonSolve.solve/init/solve!) and a few broader SciMLBase constructor/function bindings that should be handled in separate follow-ups rather than expanding this PR into an omnibus docs rewrite.Validation
Pkg.test()passed locally with Julia+release.git diff --checkpassed.docs/make.jlpassed locally with Julia+release.Known pre-existing docs warnings still emitted during docs build include undefined/manual warnings for
AbstractQuadratureAlgorithm, severaltimeseries_steps_*ensemble entries,ModelingToolkit.PDESystem, and existing non-canonical docstrings. This PR did not add new failing docs warnings; docs build exits 0.