Improve get_data_in_units docstring

NeurodataWithoutBorders · Apr 1, 2024 · 76b7504 · 76b7504
1 parent af63c5f
commit 76b7504
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/pynwb/base.py b/src/pynwb/base.py
@@ -343,14 +343,17 @@ def get_data_in_units(self):
         .. math::
             out = data * conversion + offset
 
-        If the field 'channel_conversion' is present, the conversion factor is applied to each channel separately:
+        If the field 'channel_conversion' is present, the conversion factor for each channel is additionally applied 
+        to each channel:
 
         .. math::
-            out_{channel} = data * conversion_{channel} + offset
+            out_{channel} = data * conversion * conversion_{channel} + offset
+
+        NOTE: This will read the entire dataset into memory.
 
         Returns
         -------
-        np.ndarray
+        np.array
 
         """
         if "channel_conversion" in self.fields: