Skip to content

Commit c7e1c03

Browse files
docs: fix docstrings
Co-authored-by: Aayush Sabharwal <[email protected]>
1 parent 0c53f05 commit c7e1c03

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/systems/abstractsystem.jl

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2400,8 +2400,8 @@ end
24002400
"""
24012401
is_diff_equation(eq)
24022402
2403-
Returns `true` if the input is a differential equation, i.e. is an equatation that contain some
2404-
form of differential.
2403+
Return `true` if the input is a differential equation, i.e. an equation that contains a
2404+
differential term.
24052405
24062406
Example:
24072407
```julia
@@ -2426,7 +2426,7 @@ end
24262426
"""
24272427
is_alg_equation(eq)
24282428
2429-
Returns `true` if the input is an algebraic equation, i.e. is an equatation that does not contain
2429+
Return `true` if the input is an algebraic equation, i.e. an equation that does not contain
24302430
any differentials.
24312431
24322432
Example:
@@ -2608,8 +2608,9 @@ has_alg_eqs(sys::AbstractSystem) = any(is_alg_equation, get_eqs(sys))
26082608
"""
26092609
has_diff_eqs(sys::AbstractSystem)
26102610
2611-
For a system, returns true if it contain at least one differential equation (i.e. that contain a
2612-
differential) in its *top-level system*.
2611+
Return `true` if a system contains at least one differential equation (i.e. an equation with a
2612+
differential term). Note that this does not consider subsystems, and only takes into account
2613+
equations in the top-level system.
26132614
26142615
Example:
26152616
```julia

0 commit comments

Comments
 (0)