Skip to content

Commit fb64c54

Browse files
committed
[dataarray] update docstring of get_slice
1 parent f87529c commit fb64c54

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

nixio/data_array.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,8 @@ def get_slice(self, positions, extents=None, mode=DataSliceMode.Index):
316316
```
317317
318318
Note: The extents are *not* the end positions but the extent of the slice!
319+
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
320+
exception will be raised but the returned DataView might be invalid and empty.
319321
320322
:param positions: Specifies the start of the data slice. List of either indices or data positions depending on the DataSliceMode.
321323
:type positions: list length must match dimensionality of the data.

0 commit comments

Comments
 (0)