Skip to content

Commit 434b34a

Browse files
refactor: mark collect_* functions as public
1 parent e06c029 commit 434b34a

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/src/API/System.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,3 +200,15 @@ ModelingToolkit.CheckUnits
200200
```
201201

202202
These can also be used by custom `AbstractSystem` subtypes.
203+
204+
## Utility functions
205+
206+
These utility functions can be useful when manipulating systems, especially when building
207+
custom `AbstractSystem` subtypes.
208+
209+
```@docs
210+
ModelingToolkit.collect_scoped_vars!
211+
ModelingToolkit.collect_var_to_name!
212+
ModelingToolkit.collect_vars!
213+
ModelingToolkit.eqtype_supports_collect_vars
214+
```

src/ModelingToolkit.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,8 @@ export DynamicOptSolution
341341
@public SymbolicContinuousCallback, SymbolicDiscreteCallback
342342
@public VariableType, MTKVariableTypeCtx, VariableBounds, VariableConnectType
343343
@public VariableDescription, VariableInput, VariableIrreducible, VariableMisc
344-
@public VariableOutput, VariableStatePriority, VariableUnit
344+
@public VariableOutput, VariableStatePriority, VariableUnit, collect_scoped_vars!
345+
@public collect_var_to_name!, collect_vars!, eqtype_supports_collect_vars
345346

346347
for prop in [SYS_PROPS; [:continuous_events, :discrete_events]]
347348
getter = Symbol(:get_, prop)

0 commit comments

Comments
 (0)