Skip to content

Commit

Permalink
Fix docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski committed Nov 13, 2024
1 parent a1cf336 commit 469b3b0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/spikeinterface/core/baserecording.py
Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,7 @@ def reset_times(self):

def shift_times(self, shift: int | float, segment_index: int | None = None) -> None:
"""
Shift all times by a scalar value. The default behaviour is to
shift all segments uniformly.
Shift all times by a scalar value.
Parameters
----------
Expand All @@ -523,8 +522,8 @@ def shift_times(self, shift: int | float, segment_index: int | None = None) -> N
started earlier.
segment_index : int | None
The segment on which to shift the times. if `None`, all
segments will be shifted.
The segment on which to shift the times.
If `None`, all segments will be shifted.
"""
if segment_index is None:
segments_to_shift = range(self.get_num_segments())
Expand Down

0 comments on commit 469b3b0

Please sign in to comment.