improve docstring of set state

Author: Datseris

Project.toml

@@ -1,7 +1,7 @@
 name = "DynamicalSystemsBase"
 uuid = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
 repo = "https://github.com/JuliaDynamics/DynamicalSystemsBase.jl.git"
-version = "3.11.1"
+version = "3.11.2"
 
 [deps]
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"

src/core/dynamicalsystem_interface.jl

@@ -332,7 +332,7 @@ StateSpaceSets.dimension(ds::DynamicalSystem) = length(current_state(ds))
 # API - altering status of the system
 ###########################################################################################
 """
-    set_state!(ds::DynamicalSystem, u::AbstractArray{Real})
+    set_state!(ds::DynamicalSystem, u::AbstractArray{<:Real})
 
 Set the state of `ds` to `u`, which must match dimensionality with that of `ds`.
 Also ensure that the change is notified to whatever integration protocol is used.
@@ -383,8 +383,11 @@ end
     set_state!(ds::DynamicalSystem, mapping::AbstractDict)
 
 Convenience version of `set_state!` that iteratively calls `set_state!(ds, val, i)`
-for all index-value pairs `(i, val)` in `mapping`. This allows you to
-partially set only some state variables.
+for all index-value pairs `(i, val)` in `mapping`.
+This is useful primarily in two cases:
+1) to partially set only some state variables,
+2) to set variables by name (if the system is created via ModelingToolkit.jl)
+so that you don't have to keep track of the order of the dynamic variables.
 """
 function set_state!(ds::DynamicalSystem, mapping::AbstractDict)
     # ensure we use a mutable vector, so same code works for in-place problems