From 3dcf149c31c3861c0778ce14c64dab9473ef1385 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <michiel.cottaar@ndcn.ox.ac.uk>
Date: Sun, 28 Jan 2024 21:55:30 +0000
Subject: [PATCH] Fix documentation
---
src/gradients/changing_gradient_blocks.jl | 4 ++--
src/gradients/constant_gradient_blocks.jl | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/gradients/changing_gradient_blocks.jl b/src/gradients/changing_gradient_blocks.jl
index a759eac..2ffd9cb 100644
--- a/src/gradients/changing_gradient_blocks.jl
+++ b/src/gradients/changing_gradient_blocks.jl
@@ -15,7 +15,7 @@ struct AbstractChangingGradientBlock{T<:VariableType} <: GradientBlock
end
"""
- ChangingGradientBlock(duration, gradient_strength, rotate, scale)
+ ChangingGradientBlock(grad1, grad2, duration, rotate, scale)
Underlying type for any linearly changing part in a gradient waveform.
@@ -26,7 +26,7 @@ Do not create this directly, it will be created by the gradient waveforms.
const ChangingGradientBlock = AbstractChangingGradientBlock{VariableType}
"""
- FixedChangingGradientBlock(duration, gradient_strength, rotate, scale)
+ FixedChangingGradientBlock(grad1, grad2, duration, rotate, scale)
Fixed equivalent of [`ChangingGradientBlock`](@ref).
"""
diff --git a/src/gradients/constant_gradient_blocks.jl b/src/gradients/constant_gradient_blocks.jl
index dce6fb3..4001c42 100644
--- a/src/gradients/constant_gradient_blocks.jl
+++ b/src/gradients/constant_gradient_blocks.jl
@@ -26,7 +26,7 @@ Do not create this directly, it will be created by the gradient waveforms.
const ConstantGradientBlock = AbstractConstantGradientBlock{VariableType}
"""
- FixedConstantGradientBlock(duration, gradient_strength, rotate, scale)
+ FixedConstantGradientBlock(gradient_strength, duration, rotate, scale)
Fixed equivalent of [`ConstantGradientBlock`](@ref).
"""
--
GitLab