Add comprehensive docstrings for DAE initialization algorithms #1149
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
- Document NoInit with strong warnings about usage risks - Document CheckInit as the verification-only algorithm - Document OverrideInit for ModelingToolkit integration - Include examples and use cases for each algorithm - Add field documentation for OverrideInit
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 defined in SciMLBase that previously only had placeholder TYPEDEF documentation.
Changes
Added full docstrings for:
NoInit: Includes strong warning about usage risksCheckInit: Documents verification-only behaviorOverrideInit: Documents ModelingToolkit integration use caseEach docstring includes:
Related PRs
Note
The DiffEqBase PR #1214 has been updated to remove these docstrings from there since they belong in SciMLBase where the types are defined.
🤖 Generated with Claude Code
Co-Authored-By: Claude [email protected]