Skip to content

Commit 90919cd

Browse files
author
Joseph G. Shuttleworth
committed
Add clarification to docstring
1 parent 79d75a1 commit 90919cd

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

pcpostprocess/detect_ramp_bounds.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def detect_ramp_bounds(times, voltage_sections, ramp_index=0):
99
@param voltage_sections 2d np.array where each row describes a segment of the protocol: (tstart, tend, vstart, end)
1010
@param ramp_index: the index of the ramp to select. Defaults to 0 - the first ramp
1111
12-
@returns istart, iend: the start and end timepoint indices for the specified ramp
12+
@returns istart, iend: the first timepoint of the ramp segment, and the first time point of the following ramp segment
1313
"""
1414

1515
ramps = [(tstart, tend, vstart, vend) for tstart, tend, vstart, vend

0 commit comments

Comments
 (0)