Skip to content

Commit ea84b09

Browse files
docs: format
1 parent 69c71bf commit ea84b09

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/src/basics/FAQ.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@ Indexes into the `MTKParameters` object take the form of `ParameterIndex` object
2020
are similarly undocumented. Following is the list of behaviors that should be relied on for
2121
`MTKParameters`:
2222

23-
- It implements the SciMLStructures interface.
24-
- It can be queried for parameters using functions returned from
25-
`SymbolicIndexingInterface.getp`.
26-
- `getindex(::MTKParameters, ::ParameterIndex)` can be used to obtain the value of a
27-
parameter with the given index.
28-
- `setindex!(::MTKParameters, value, ::ParameterIndex)` can be used to set the value of a
29-
parameter with the given index.
30-
- `parameter_values(sys, sym)` will return a `ParameterIndex` object if `sys` has been
31-
`complete`d (through `structural_simplify`, `complete` or `@mtkbuild`).
32-
- `copy(::MTKParameters)` is defined and duplicates the parameter object, including the
33-
memory used by the underlying buffers.
23+
- It implements the SciMLStructures interface.
24+
- It can be queried for parameters using functions returned from
25+
`SymbolicIndexingInterface.getp`.
26+
- `getindex(::MTKParameters, ::ParameterIndex)` can be used to obtain the value of a
27+
parameter with the given index.
28+
- `setindex!(::MTKParameters, value, ::ParameterIndex)` can be used to set the value of a
29+
parameter with the given index.
30+
- `parameter_values(sys, sym)` will return a `ParameterIndex` object if `sys` has been
31+
`complete`d (through `structural_simplify`, `complete` or `@mtkbuild`).
32+
- `copy(::MTKParameters)` is defined and duplicates the parameter object, including the
33+
memory used by the underlying buffers.
3434

3535
Any other behavior of `MTKParameters` (other `getindex`/`setindex!` methods, etc.) is an
3636
undocumented internal and should not be relied upon.

0 commit comments

Comments
 (0)