Skip to content

tweak docs #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2021
Merged

tweak docs #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
subsystems it is not currently possible to convert to a `JumpSystem`. It is
also not possible to include either `SDESystem`s or `JumpSystems` as
subsystems.
- Depreciated `merge`, use `ModelingToolkit.extend` instead.
- Depreciated `params` and `numparams` (use `ModelingToolkit.parameters` to get
- Deprecated `merge`, use `ModelingToolkit.extend` instead.
- Deprecated `params` and `numparams` (use `ModelingToolkit.parameters` to get
all parameters of a system and all subsystems, or use `reactionparams` to get
all parameters of a system and all `ReactionSystem` subsystems. The latter
correspond to those parameters used within `Reaction`s.)
Expand Down
5 changes: 3 additions & 2 deletions docs/src/tutorials/generated_systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ following ModelingToolkit functions provide this information
* [`equations(rn)`](@ref) returns all [`Reaction`](@ref)s and all
[`Equations`](@ref) defined across the system and *all sub-systems*.

These accessors will allocate unless there are no subsystems. In the latter case
they are equivalent to the corresponding `get_*` functions.
`states` and `parameters` should be assumed to always allocate, while
`equations` will allocate unless there are no subsystems. In the latter case
`equations` is equivalent to `get_eqs`.

Empty `ReactionSystem`s can be generated via [`make_empty_network`](@ref) or
[`@reaction_network`](@ref) with no arguments (giving one argument to the latter
Expand Down