From 93a2c630824fc4b524d604f28928c22a3d3d5680 Mon Sep 17 00:00:00 2001 From: Steph Prince <40640337+stephprince@users.noreply.github.com> Date: Wed, 10 Jan 2024 16:46:24 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Oliver Ruebel --- docs/gallery/domain/plot_icephys.py | 7 ++++--- src/pynwb/base.py | 12 +++++++----- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/gallery/domain/plot_icephys.py b/docs/gallery/domain/plot_icephys.py index 9e5da899d..162714845 100644 --- a/docs/gallery/domain/plot_icephys.py +++ b/docs/gallery/domain/plot_icephys.py @@ -459,9 +459,10 @@ ) ##################################################################### -# One predefined subcategory column is the stimulus template column in the stimuli table. This column can be used to -# store stimulus template waveforms that were generated by the recording software. Similar to the stimulus and response -# columns, we can specify a relevant time range. +# One predefined subcategory column is the ``stimulus_template`` column in the stimuli table. This column is +# used to store template waveforms of stimuli in addition to the actual recorded stimulus that is stored in the +# ``stimulus`` column. Similar to the ``stimulus`` and ``response`` columns, we can specify a relevant +# time range. nwbfile.intracellular_recordings.add_column( name="stimulus_template", diff --git a/src/pynwb/base.py b/src/pynwb/base.py index 044a2c840..f47414328 100644 --- a/src/pynwb/base.py +++ b/src/pynwb/base.py @@ -505,11 +505,13 @@ def empty(cls, timeseries): When missing data needs to be represented, NWB defines ``None`` for the complex data type ``(idx_start, count, TimeSeries)`` as (-1, -1, TimeSeries) for storage. The exact timeseries object will technically not - matter since the empty reference is a way of indicating a NaN value. In practice, this may be used in the - :py:class:`~pynwb.icephys.IntracellularRecordingsTable` where only one of stimulus or response data was - recorded. In such cases, the timeseries object for the empty stimulus TimeSeriesReference could be set to the - response series or vice versa (the timeseries object for the empty response TimeSeriesReference could be set - to the stimulus) + matter since the empty reference is a way of indicating a NaN value. in a + :py:class:`~pynwb.base.TimeSeriesReferenceVectorData` column. + + An example, where this functionality is used is :py:class:`~pynwb.icephys.IntracellularRecordingsTable` + where only one of stimulus or response data was recorded. In such cases, the timeseries object for the + empty stimulus :py:class:`~pynwb.base.TimeSeriesReference` could be set to the response series, or + vice versa. :returns: Returns :py:class:`~pynwb.base.TimeSeriesReference` """