Clarify Units.spike_times and Units.obs_intervals documentation#676
Open
h-mayorquin wants to merge 2 commits intodevfrom
Open
Clarify Units.spike_times and Units.obs_intervals documentation#676h-mayorquin wants to merge 2 commits intodevfrom
h-mayorquin wants to merge 2 commits intodevfrom
Conversation
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
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.
Summary of changes
The
spike_timesandobs_intervalsdoc strings in theUnitstype now specify that times are relative to the session reference time (i.e.session_start_timeor, if defined,timestamps_reference_time). Thespike_timesdoc states that values should be stored in ascending order, andobs_intervalsadds that intervals should be non-overlapping. These are documentation-only changes that codify existing assumptions without breaking any files.Checklist
For all schema changes:
docs/format/source/format_release_notes.rst.hdmf-common-schemapoints to the latest release and not the latest commit on themainbranch.