add note in docstring

scipp · Jan 29, 2024 · 6cc9c9d · 6cc9c9d
1 parent 91d4f31
commit 6cc9c9d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/esssans/i_of_q.py b/src/esssans/i_of_q.py
@@ -138,6 +138,9 @@ def dimension_slicing(
 ) -> SlicedMaskedData[RunType]:
     """
     Slice out a subset of the detector tubes/straws/layers/pixels.
+
+    Note that the slicing must be done after masking and computing the beam center, if
+    not the results will be different between sliced and non-sliced data.
     """
     out = data
     if slices is not None: