Skip to content

Commit 438a225

Browse files
committed
docs(refactor): rename the @mtkmodel docs page as "Defining components with @mtkmodel and connectors with @connectors" to indicate that it describes @connectors too.
1 parent 94fb749 commit 438a225

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

docs/src/basics/MTKModel_Connector.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1-
# Defining components with `@mtkmodel`
1+
# [Defining components with `@mtkmodel` and connectors with `@connectors`](@id mtkmodel-connectors)
22

3-
`@mtkmodel` is a convenience macro to define ModelingToolkit components. It returns `ModelingToolkit.Model`, which includes a constructor that returns an ODESystem, a `structure` dictionary with metadata and flag `isconnector` which is set to `false`.
3+
## MTK Model
4+
5+
MTK represents components and connectors with `Model`.
6+
7+
```@docs
8+
ModelingToolkit.Model
9+
```
10+
11+
## Components
12+
13+
Components are models from various domains. These models contain states and their
14+
equations.
15+
16+
### [Defining components with `@mtkmodel`](@id mtkmodel)
17+
18+
`@mtkmodel` is a convenience macro to define components. It returns
19+
`ModelingToolkit.Model`, which includes a constructor that returns the ODESystem, a
20+
`structure` dictionary with metadata, and flag `isconnector` which is set to `false`.
421

522
## What can an MTK-Model definition have?
623

0 commit comments

Comments
 (0)