Add documentation for undocumented SciMLBase API components #1107
Conversation
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
- Add FunctionWrappers.md: Documents AD integration wrappers - Add IntegratorInterface.md: Documents fine-grained solver control - Add EnsembleAnalysis.md: Documents statistical analysis functions - Add ClockSystem.md: Documents discrete/hybrid timing system - Add AlgorithmTraits.md: Documents algorithm capability traits - Update pages.jl to include new documentation files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Improve EnsembleAnalysis.md with additional advanced functions - Enhance AlgorithmTraits.md with more comprehensive examples - Add SpecializedProblems.md documenting specialized problem types: * NonlinearLeastSquaresProblem, SCCNonlinearProblem * SampledIntegralProblem, IncrementingODEProblem * TwoPointBVProblem, IntervalNonlinearProblem * HomotopyNonlinearFunction and related types - Update pages.jl to include new documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Remove IntegratorInterface.md and FunctionWrappers.md documentation pages - Add proper docstrings to function wrapper types in src/function_wrappers.jl: * AbstractWrappedFunction, TimeGradientWrapper, UJacobianWrapper * TimeDerivativeWrapper, UDerivativeWrapper, ParamJacobianWrapper * JacobianWrapper - all with comprehensive documentation - Add docstrings to integrator cache functions in src/integrator_interface.jl: * user_cache, u_cache, du_cache, ratenoise_cache, rand_cache - Add docstrings to clock trait functions in src/clock.jl: * isclock, issolverstepclock, iscontinuous, iseventclock * is_discrete_time_domain - Update pages.jl to remove deleted documentation files - Documentation builds successfully with proper docstring integration This follows best practices by documenting the API directly in source code rather than maintaining separate documentation files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Delete SpecializedProblems.md - information should come from docstrings - Delete EnsembleAnalysis.md - functions already have proper docstrings - Delete AlgorithmTraits.md - algorithm traits should be documented via docstrings - Update pages.jl to remove references to deleted documentation files - Documentation builds successfully with streamlined approach This completes the transition to a docstring-only documentation approach, ensuring API documentation is maintained directly in source code rather than separate markdown files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
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.
Summary
This PR adds comprehensive documentation for several undocumented parts of the SciMLBase.jl general API. Based on analysis of the codebase, I've identified and documented major gaps in the public API documentation.
New Documentation Added
1. Function Wrappers (
interfaces/FunctionWrappers.md)TimeGradientWrapper,UJacobianWrapper,TimeDerivativeWrapperUDerivativeWrapper,ParamJacobianWrapper,JacobianWrapper2. Integrator Interface (
interfaces/IntegratorInterface.md)get_tmp_cache,resize_non_user_cache!, etc.add_tstop!,set_t!,get_dt, etc.set_u!,u_modified!,terminate!, etc.3. Ensemble Analysis (
interfaces/EnsembleAnalysis.md)timestep_mean,timepoint_quantile, etc.timeseries_steps_mean,componentwise_meantimepoint_cor,timestep_cov4. Clock System (
interfaces/ClockSystem.md)PeriodicClock,EventClock,SolverStepClockis_discrete_time_domain,isclock, etc.5. Algorithm Traits (
interfaces/AlgorithmTraits.md)isautodifferentiable,forwarddiffs_modelallows_arbitrary_number_types,allowscomplexisadaptive,isdiscrete, etc.isinplace,numargs,check_keywordsImpact
These additions document approximately 100+ exported functions and types that were previously undocumented, representing substantial portions of the public API that advanced users need for:
Documentation Build
✅ Documentation builds successfully with
julia --project=docs/ docs/make.jl✅ All new files are properly integrated into the documentation structure via
pages.jl✅ Code formatted with JuliaFormatter using SciMLStyle
Test Plan
The documentation build passes successfully. No code changes were made - only documentation additions.
🤖 Generated with Claude Code