Skip to content

Commit

Permalink
Add description to AbstractSystem documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hersle committed Oct 20, 2024
1 parent 2bc4b16 commit f7e956f
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/basics/AbstractSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Optionally, a system could have:
- `get_defaults(sys)`: A `Dict` that maps variables into their default values
for the current-level system.
- `get_noiseeqs(sys)`: Noise equations of the current-level system.
- `get_description(sys)`: A string that describes what a system represents.
- `get_metadata(sys)`: Any metadata about the system or its origin to be used by downstream packages.

Note that if you know a system is an `AbstractTimeDependentSystem` you could use `get_iv` to get the
Expand Down

0 comments on commit f7e956f

Please sign in to comment.