Skip to content

Commit 02c6300

Browse files
committed
more alias explanation
1 parent ead4d02 commit 02c6300

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/src/interfaces/Common_Keywords.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ Note that if a method does not have adaptivity, the following rules apply:
103103

104104
- `alias`: an `AbstractAliasSpecifier` object that holds fields specifying which variables to alias
105105
when solving. For example, to tell an ODE solver to alias the `u0` array, you can use an `ODEAliases` object,
106-
and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`. The fields of
107-
every `AbstractAliasSpecifier` default to `nothing`, which tells the solver to use its default behavior.
106+
and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`.
108107
For more information on what can be aliased for each problem type, see the documentation for the `AbstractAliasSpecifier`
109-
associated with that problem type.
108+
associated with that problem type. Set to `true` to alias every variable possible, or to `false` to disable aliasing.
109+
Defaults to an `AbstractAliasSpecifier` instance with `nothing` for all fields, which tells the solver to use the default behavior.
110110
- `cache`: pass a solver cache to decrease the construction time. This is not implemented
111111
for any of the problem interfaces at this moment.
112112

0 commit comments

Comments
 (0)