Add comprehensive docstrings for all DAE initialization algorithms #1214
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 docstrings for CheckInit, NoInit, and OverrideInit from SciMLBase - Re-export these algorithms for convenience - Update solve docstring to include OverrideInit in the list - Include examples and use cases for each algorithm
- Remove docstrings for CheckInit, NoInit, and OverrideInit - These should be documented in SciMLBase where the types are defined - Keep re-exports for user convenience - Add note that docstrings should be in SciMLBase
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 docstrings for the DAE initialization algorithms that are unique to DiffEqBase.
Changes
Added docstrings for DiffEqBase algorithms:
DefaultInit,BrownBasicInit, andShampineCollocationInitRe-exported SciMLBase algorithms:
Updated solve docstring:
Important Note
The docstrings for
CheckInit,NoInit, andOverrideInithave been moved to SciMLBase where these types are actually defined. See PR SciML/SciMLBase.jl#1149Related PRs
This ensures proper separation of concerns - types are documented where they're defined.
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com