Skip to content
Snippets Groups Projects
Verified Commit 9c9bb8cc authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

Fix docstring taking into accout `optimise`

parent f967ac6a
No related branches found
No related tags found
No related merge requests found
...@@ -32,7 +32,7 @@ You can also add any arbitrary constraints or objectives using the same syntax a ...@@ -32,7 +32,7 @@ You can also add any arbitrary constraints or objectives using the same syntax a
@constraint global_model() duration(seq) == 30. @constraint global_model() duration(seq) == 30.
``` ```
As soon as the code block is the optimal sequence matching all your constraints and objectives will be returned. As soon as the code block ends the sequence is optimised (if `optimise=true`) and returned.
## Parameters ## Parameters
- `scanner`: Set to a [`Scanner`](@ref) to limit the gradient strength and slew rate. When this call to `build_sequence` is embedded in another, this parameter can be set to `nothing` to indicate that the same scanner should be used. - `scanner`: Set to a [`Scanner`](@ref) to limit the gradient strength and slew rate. When this call to `build_sequence` is embedded in another, this parameter can be set to `nothing` to indicate that the same scanner should be used.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment