Skip to content

Commit

Permalink
Improve reset_times docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
alejoe91 committed Sep 5, 2024
1 parent 3c9a3e4 commit 7d50fc5
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/spikeinterface/core/baserecording.py
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,11 @@ def set_times(self, times, segment_index=None, with_warning=True):
)

def reset_times(self):
"""Reset times in-memory for all segments that have a time vector."""
"""
Reset times in-memory for all segments that have a time vector.
If the timestamps come from a file, the files won't be modified. but only the in-memory
attributes of the recording objects are deleted.
"""
for segment_index in range(self.get_num_segments()):
if self.has_time_vector(segment_index):
rs = self._recording_segments[segment_index]
Expand Down

0 comments on commit 7d50fc5

Please sign in to comment.