Skip to content

Fix recording slicing docstrings and documentation typo #3939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
h-mayorquin merged 3 commits into from
May 20, 2025
Merged

Fix recording slicing docstrings and documentation typo #3939

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6ee09b
Fix typo in combine_recordings.rst
kushaangupta May 16, 2025
177b8c2
Update recording slicing docstrings describing default behavior
kushaangupta May 20, 2025
4785036
Merge branch 'main' into main
zm711 May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/how_to/combine_recordings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Combine recordings in SpikeInterface
In this tutorial we will walk through combining multiple recording objects. Sometimes this occurs due to hardware
settings (e.g. Intan software has a default setting of new files every 1 minute) or the experimenter decides to
split their recording into multiple files for different experimental conditions. If the probe has not been moved,
however, then during sorting it would likely make sense to combine these individual reocrding objects into one
however, then during sorting it would likely make sense to combine these individual recording objects into one
recording object.

**Why Combine?**
Expand Down
8 changes: 4 additions & 4 deletions src/spikeinterface/core/baserecording.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,9 +749,9 @@ def frame_slice(self, start_frame: int | None, end_frame: int | None) -> BaseRec
Parameters
----------
start_frame : int, optional
The start frame, if not provided it is set to 0
Start frame index. If None, defaults to the beginning of the recording (frame 0).
end_frame : int, optional
The end frame, it not provided it is set to the total number of samples
End frame index. If None, defaults to the last frame of the recording.

Returns
-------
Expand All @@ -771,9 +771,9 @@ def time_slice(self, start_time: float | None, end_time: float | None) -> BaseRe
Parameters
----------
start_time : float, optional
The start time in seconds. If not provided it is set to 0.
Start time in seconds. If None, defaults to the beginning of the recording.
Copy link
Copy Markdown
Collaborator

@h-mayorquin h-mayorquin May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This an important change. 0 is in fact wrong.

Thanks for the fix.

end_time : float, optional
The end time in seconds. If not provided it is set to the total duration.
End time in seconds. If None, defaults to the end of the recording.

Returns
-------
Expand Down