Documentation improvements: Add comprehensive docstrings to all algorithms#93
Merged
ChrisRackauckas merged 1 commit intoSciML:masterfrom Dec 30, 2025
Conversation
- Added detailed docstrings to all exported algorithm structs - Each docstring includes: * Brief description of the method * Usage examples demonstrating the solver * Parameter documentation * Feature highlights * Cross-references to related solvers - Covered all solver categories: * ODE solvers (SimpleEuler, LoopEuler, SimpleRK4, LoopRK4) * Adaptive ODE solvers (SimpleATsit5) * High-order solvers (SimpleTsit5, Verner methods) * GPU-compatible variants (GPUSimple*) * SDE solver (SimpleEM) * Discrete solver (SimpleFunctionMap) - All examples tested and verified to work correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.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.
Summary
This PR adds comprehensive docstrings to all exported algorithm types in SimpleDiffEq.jl. Previously, algorithm structs had no documentation, making it difficult for users to understand what each solver does and how to use it.
Changes
Added detailed docstrings to all 19 algorithm types:
ODE Solvers
SimpleEuler- Forward Euler methodLoopEuler- Teaching/benchmarking variant of EulerGPUSimpleEuler- GPU-compatible EulerSimpleRK4- Classic RK4 with FSAL and interpolationLoopRK4- Teaching/benchmarking variant of RK4GPUSimpleRK4- GPU-compatible RK4SimpleTsit5- Tsitouras 5th order fixed stepSimpleATsit5- Adaptive Tsitouras 5th orderGPUSimpleTsit5- GPU-compatible Tsit5 fixed stepGPUSimpleATsit5- GPU-compatible adaptive Tsit5GPUSimpleVern7- GPU-compatible Verner 7th orderGPUSimpleAVern7- GPU-compatible adaptive Verner 7th orderGPUSimpleVern9- GPU-compatible Verner 9th orderGPUSimpleAVern9- GPU-compatible adaptive Verner 9th orderOther Solvers
SimpleEM- Euler-Maruyama for SDEsSimpleFunctionMap- Discrete map iterationDocumentation Structure
Each docstring includes:
Testing
Examples
Before (no docstring):
After (comprehensive docstring):
cc: @ChrisRackauckas
🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com