Skip to content

Commit

Permalink
[dataarray] update docstring of get_slice
Browse files Browse the repository at this point in the history
  • Loading branch information
jgrewe committed Mar 18, 2022
1 parent f87529c commit fb64c54
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions nixio/data_array.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fb64c54

Please sign in to comment.