Skip to content

Commit 0841834

Browse files
authored
Fix recording slicing docstrings and documentation typo (#3939)
* Fix typo in combine_recordings.rst * Update recording slicing docstrings describing default behavior
1 parent 03c818c commit 0841834

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

doc/how_to/combine_recordings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Combine recordings in SpikeInterface
44
In this tutorial we will walk through combining multiple recording objects. Sometimes this occurs due to hardware
55
settings (e.g. Intan software has a default setting of new files every 1 minute) or the experimenter decides to
66
split their recording into multiple files for different experimental conditions. If the probe has not been moved,
7-
however, then during sorting it would likely make sense to combine these individual reocrding objects into one
7+
however, then during sorting it would likely make sense to combine these individual recording objects into one
88
recording object.
99

1010
**Why Combine?**

src/spikeinterface/core/baserecording.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -749,9 +749,9 @@ def frame_slice(self, start_frame: int | None, end_frame: int | None) -> BaseRec
749749
Parameters
750750
----------
751751
start_frame : int, optional
752-
The start frame, if not provided it is set to 0
752+
Start frame index. If None, defaults to the beginning of the recording (frame 0).
753753
end_frame : int, optional
754-
The end frame, it not provided it is set to the total number of samples
754+
End frame index. If None, defaults to the last frame of the recording.
755755
756756
Returns
757757
-------
@@ -771,9 +771,9 @@ def time_slice(self, start_time: float | None, end_time: float | None) -> BaseRe
771771
Parameters
772772
----------
773773
start_time : float, optional
774-
The start time in seconds. If not provided it is set to 0.
774+
Start time in seconds. If None, defaults to the beginning of the recording.
775775
end_time : float, optional
776-
The end time in seconds. If not provided it is set to the total duration.
776+
End time in seconds. If None, defaults to the end of the recording.
777777
778778
Returns
779779
-------

0 commit comments

Comments
 (0)