Skip to content

Commit 975679d

Browse files
author
sprenger
committed
Add missing parameter descriptions to some docstrings
1 parent a1a56e5 commit 975679d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

nixio/data_array.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ def append_set_dimension(self, labels=None):
8282
Append a new SetDimension to the list of existing dimension
8383
descriptors.
8484
85+
:param labels: The set of sample labels
86+
:type labels: list or convertible to list
87+
8588
:returns: The newly created SetDimension.
8689
:rtype: nixio.SetDimension
8790
"""
@@ -103,6 +106,12 @@ def append_sampled_dimension(self, sampling_interval, label=None,
103106
104107
:param sampling_interval: The sampling interval of the SetDimension to create.
105108
:type sampling_interval: float
109+
:param label: The label of the dimension
110+
:type label: str
111+
:param unit: The physical unit of the dimension
112+
:type unit: str
113+
:param offset: The offset between 0 and the first sample
114+
:type offset: float
106115
107116
:returns: The newly created SampledDimension.
108117
:rtype: nixio.SampledDimension
@@ -126,6 +135,10 @@ def append_range_dimension(self, ticks=None, label=None, unit=None):
126135
127136
:param ticks: The ticks of the RangeDimension to create.
128137
:type ticks: list of float
138+
:param label: The label of the dimension
139+
:type label: str
140+
:param unit: The physical unit of the dimension
141+
:type unit: str
129142
130143
:returns: The newly created RangeDimension.
131144
:rtype: nixio.RangeDimension

0 commit comments

Comments
 (0)