Fix recording slicing docstrings and documentation typo#3939
Merged
h-mayorquin merged 3 commits intoSpikeInterface:mainfrom May 20, 2025
kushaangupta:main
Merged
Fix recording slicing docstrings and documentation typo#3939h-mayorquin merged 3 commits intoSpikeInterface:mainfrom kushaangupta:main
h-mayorquin merged 3 commits intoSpikeInterface:mainfrom
kushaangupta:main
Conversation
h-mayorquin
approved these changes
May 20, 2025
Collaborator
h-mayorquin
left a comment
h-mayorquin
left a comment
There was a problem hiding this comment.
Thanks for your contribution. This is more explicit and fixes a place where the documentation was wrong.
As mentioned in the issue I think we should set default values None but this should be done in a different PR.
| ---------- | ||
| 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. |
Collaborator
There was a problem hiding this comment.
This an important change. 0 is in fact wrong.
Thanks for the fix.
zm711
approved these changes
May 20, 2025
Member
There was a problem hiding this comment.
Thanks! And thanks for checking on the actual behavior!
@h-mayorquin , I thought the idea with no default was that we force the user to make a choice rather than silently do anything. So I agree better for a different PR where we can discuss what we think default behavior should be.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3938