Skip to content

Commit e80984f

Browse files
committed
[dimension] docstring fixes
1 parent 0132fce commit e80984f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

nixio/dimensions.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ def is_alias(self):
557557
elif self.has_link and self.dimension_link._data_object_type == "DataArray":
558558
return True
559559
return False
560-
560+
561561
@property
562562
def _redirgrp(self):
563563
"""
@@ -569,7 +569,7 @@ def _redirgrp(self):
569569
gname = self._h5group.get_by_pos(0).name
570570
return self._h5group.open_group(gname)
571571
return self._h5group
572-
572+
573573
@property
574574
def ticks(self):
575575
if self.is_alias and not self.has_link:
@@ -638,6 +638,8 @@ def index_of(self, position, mode=IndexMode.LessOrEqual, ticks=None):
638638
If the mode is Less, the previous index of the matching tick is always returned.
639639
If the mode is GreaterOrEqual and the position does not match a tick exactly, the next index is
640640
returned.
641+
:param ticks: Optional, the ticks stored in this dimension. If not passed as argument, they are (re)read from file.
642+
:type ticks: iterable
641643
642644
:returns: The matching index
643645
:rtype: int
@@ -786,6 +788,7 @@ def index_of(self, position, mode=IndexMode.LessOrEqual, dim_labels=None):
786788
rounded down (for LessOrEqual) or rounded up (for GreaterOrEqual).
787789
If the mode is Less, the previous integer is always returned.
788790
:param dim_labels: The labels of this dimension, if None (default) the labels will be read from file.
791+
:type dim_labels: iterable
789792
790793
:returns: The matching index
791794
:rtype: int

0 commit comments

Comments
 (0)