Skip to content

Clarify Units.spike_times and Units.obs_intervals documentation#676

Open
h-mayorquin wants to merge 2 commits intodevfrom
spike_times_ordered
Open

Clarify Units.spike_times and Units.obs_intervals documentation#676
h-mayorquin wants to merge 2 commits intodevfrom
spike_times_ordered

Conversation

@h-mayorquin
Copy link
Copy Markdown
Contributor

Summary of changes

The spike_times and obs_intervals doc strings in the Units type now specify that times are relative to the session reference time (i.e. session_start_time or, if defined, timestamps_reference_time). The spike_times doc states that values should be stored in ascending order, and obs_intervals adds that intervals should be non-overlapping. These are documentation-only changes that codify existing assumptions without breaking any files.

Checklist

For all schema changes:

  • Add release notes for the PR to docs/format/source/format_release_notes.rst.
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.
  • Make sure that hdmf-common-schema points to the latest release and not the latest commit on the main branch.

@h-mayorquin h-mayorquin requested a review from bendichter March 24, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant