Skip to content

Commit f7e956f

Browse files
committed
Add description to AbstractSystem documentation
1 parent 2bc4b16 commit f7e956f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/src/basics/AbstractSystem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Optionally, a system could have:
6363
- `get_defaults(sys)`: A `Dict` that maps variables into their default values
6464
for the current-level system.
6565
- `get_noiseeqs(sys)`: Noise equations of the current-level system.
66+
- `get_description(sys)`: A string that describes what a system represents.
6667
- `get_metadata(sys)`: Any metadata about the system or its origin to be used by downstream packages.
6768

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

0 commit comments

Comments
 (0)