From 74346fa080ddc093b6ed94e508e68bd54edba80d Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Tue, 20 Jan 2026 12:19:09 -0600 Subject: [PATCH 1/2] Improve UnitsTable resolution docs --- core/nwb.misc.yaml | 8 ++++---- docs/format/source/format_release_notes.rst | 2 ++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/core/nwb.misc.yaml b/core/nwb.misc.yaml index 2d01fa82..3180de92 100644 --- a/core/nwb.misc.yaml +++ b/core/nwb.misc.yaml @@ -199,10 +199,10 @@ groups: attributes: - name: resolution dtype: float64 - doc: The smallest possible difference between two spike times. Usually 1 divided by the acquisition sampling rate - from which spike times were extracted, but could be larger if the acquisition time series was downsampled or - smaller if the acquisition time series was smoothed/interpolated and it is possible for the spike time to be - between samples. + doc: The temporal resolution of the spike times, in seconds. This is typically the sampling period (1/sampling_rate) + of the acquisition data from which spikes were extracted. Notes - (1) If the acquisition data was downsampled before + spike sorting, the resolution will be larger (coarser) than the original acquisition sampling period. (2) If + interpolation was applied during spike sorting, spike times may fall between samples of the acquisition data. required: false - name: obs_intervals_index neurodata_type_inc: VectorIndex diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst index 2be07957..4337938e 100644 --- a/docs/format/source/format_release_notes.rst +++ b/docs/format/source/format_release_notes.rst @@ -12,6 +12,8 @@ Minor changes that are typically used together for analysis, such as spike sorting. (#659) - Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``) should be in microns. (#658) +- Improved documentation of ``Units.spike_times.resolution`` to clarify that it represents the temporal resolution + (sampling period) of the spike times. (#XXX) 2.9.0 (June 26, 2025) From 1b63da73edb0ecab2f3870d1203d8d4bb84c009e Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Tue, 20 Jan 2026 12:22:04 -0600 Subject: [PATCH 2/2] Add PR number on release notes --- docs/format/source/format_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst index 4337938e..d421a10f 100644 --- a/docs/format/source/format_release_notes.rst +++ b/docs/format/source/format_release_notes.rst @@ -13,7 +13,7 @@ Minor changes - Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``) should be in microns. (#658) - Improved documentation of ``Units.spike_times.resolution`` to clarify that it represents the temporal resolution - (sampling period) of the spike times. (#XXX) + (sampling period) of the spike times. (#666) 2.9.0 (June 26, 2025)