Do not export Spinor-related functions (no warnings in docs)

JuliaHealth · Dec 21, 2023 · 11fa41a · cncastillo · Dec 21, 2023 · 11fa41a
1 parent 109eb65
commit 11fa41a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/KomaMRICore/src/KomaMRICore.jl b/KomaMRICore/src/KomaMRICore.jl
@@ -48,8 +48,6 @@ export Grad, RF, ADC, Delay
 export Mag, dur
 #Phantom
 export brain_phantom2D, brain_phantom3D
-#Spinors
-export Spinor, Rx, Ry, Rz, Q, Un
 #Secondary
 export get_kspace, rotx, roty, rotz
 #ISMRMRD

diff --git a/KomaMRICore/test/runtests.jl b/KomaMRICore/test/runtests.jl
@@ -415,6 +415,8 @@ end
 end
 
 @testitem "Spinors×Mag" tags=[:core] begin
+    import KomaMRICore: Spinor, Rx, Ry, Rz, Q, Un
+
     # Spinor 2x2 representation should be equivalent to a 3x1 vector rotation
     x = rand(3); x = x./sum(x)
     θ = rand() * π

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -225,6 +225,10 @@ read_phantom_MRiLab
 
 ## Functor Functions
 
+```@meta
+CurrentModule = KomaMRICore
+```
+
 ### `f32`
 ```@docs
 f32