From fb64c546d0b322574ec58ebd281829a40adf715b Mon Sep 17 00:00:00 2001 From: Jan Grewe Date: Fri, 18 Mar 2022 14:30:05 +0100 Subject: [PATCH] [dataarray] update docstring of get_slice --- nixio/data_array.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/nixio/data_array.py b/nixio/data_array.py index 21819a4a..e94e147a 100644 --- a/nixio/data_array.py +++ b/nixio/data_array.py @@ -316,6 +316,8 @@ def get_slice(self, positions, extents=None, mode=DataSliceMode.Index): ``` Note: The extents are *not* the end positions but the extent of the slice! + In the case of regularly sampled dimensions, reaching beyond the start of end of the respective dimension will cause an exception. For irregularly sampled data no + exception will be raised but the returned DataView might be invalid and empty. :param positions: Specifies the start of the data slice. List of either indices or data positions depending on the DataSliceMode. :type positions: list length must match dimensionality of the data.