Deprecate EventWaveform

core/nwb.ecephys.yaml

@@ -69,9 +69,8 @@ groups:
   neurodata_type_inc: ElectricalSeries
   doc: "Stores snapshots/snippets of recorded spike events (i.e., threshold crossings). This
     may also be raw data, as reported by ephys hardware. If so, the TimeSeries::description
-    field should describe how events were detected. All SpikeEventSeries should
-    reside in a module (under EventWaveform interface) even if the spikes were reported
-    and stored by hardware. All events span the same recording channels and store
+    field should describe how events were detected. All events span the same recording
+    channels and store
     snapshots of equal duration. TimeSeries::data array structure: [num events]
     [num channels] [num samples] (or [num events] [num samples] for single electrode)."
   datasets:
@@ -191,7 +190,7 @@ groups:
 - neurodata_type_def: EventWaveform
   neurodata_type_inc: NWBDataInterface
   default_name: EventWaveform
-  doc: Represents either the waveforms of detected events, as extracted from a raw
+  doc: DEPRECATED. Represents either the waveforms of detected events, as extracted from a raw
     data trace in /acquisition, or the event waveforms that were stored during experiment
     acquisition.
   groups:

docs/format/source/format_release_notes.rst

@@ -14,6 +14,7 @@ Minor changes
   when each unit is associated with a different number of electrodes and there is a waveform mean/SD for each
   electrode and unit. (#576)
 - Added optional ``was_generated_by`` attribute to ``NWBFile`` to store provenance information (#578)
+- Deprecated ``EventWaveform`` neurodata type. (#584)
 
 - Deprecated ``ImageMaskSeries`` neurodata type. (#583)