From 9c9bb8ccb40cc62545fc9d61e69c0e2b94f81466 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <michiel.cottaar@ndcn.ox.ac.uk>
Date: Fri, 2 Feb 2024 13:32:24 +0000
Subject: [PATCH] Fix docstring taking into accout `optimise`

---
 src/build_sequences.jl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/build_sequences.jl b/src/build_sequences.jl
index 15ce413..3585d25 100644
--- a/src/build_sequences.jl
+++ b/src/build_sequences.jl
@@ -32,7 +32,7 @@ You can also add any arbitrary constraints or objectives using the same syntax a
 @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
 - `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. 
-- 
GitLab