Add comprehensive docstrings for key functions and types #33
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
Member
hstrey
commented
Jun 16, 2025
hstrey
commented
- apply_subsystem_noise!: Stochastic noise application
- discrete_event_condition: Event trigger conditions
- apply_discrete_event!: Event handling and state modification
- get_tag, get_params, get_states: Accessor functions
- ConnectionMatrices: Multi-type connection container with diagram
- ConnectionMatrix: Block matrix structure with ASCII visualization
- graph_ode!: Core simulation function with detailed flow diagram
- apply_subsystem_noise\!: Stochastic noise application - discrete_event_condition: Event trigger conditions - apply_discrete_event\!: Event handling and state modification - get_tag, get_params, get_states: Accessor functions - ConnectionMatrices: Multi-type connection container with diagram - ConnectionMatrix: Block matrix structure with ASCII visualization - graph_ode\!: Core simulation function with detailed flow diagram
Collaborator
MasonProtter
left a comment
MasonProtter
left a comment
There was a problem hiding this comment.
Some pretty okay docstrings in here, but also some that I'm not really happy with, so I'm just going to remove them and retry later
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.