diff --git a/docs/gallery/domain/ecephys.py b/docs/gallery/domain/ecephys.py index 48a979272..30f05a031 100644 --- a/docs/gallery/domain/ecephys.py +++ b/docs/gallery/domain/ecephys.py @@ -77,10 +77,16 @@ # # The electrodes table references a required :py:class:`~pynwb.ecephys.ElectrodeGroup`, which is used to represent a # group of electrodes. Before creating an :py:class:`~pynwb.ecephys.ElectrodeGroup`, you must define a -# :py:class:`~pynwb.device.Device` object using the method :py:meth:`.NWBFile.create_device`. - +# :py:class:`~pynwb.device.Device` object using the method :py:meth:`.NWBFile.create_device`. The fields +# ``description``, ``manufacturer``, ``model_number``, ``model_name``, and ``serial_number`` are optional, but +# recommended. device = nwbfile.create_device( - name="array", description="the best array", manufacturer="Probe Company 9000" + name="array", + description="A 12-channel array with 4 shanks and 3 channels per shank", + manufacturer="Array Technologies", + model_number="PRB_1_4_0480_123", + model_name="Neurovoxels 0.99", + serial_number="1234567890", ) ####################### diff --git a/docs/gallery/domain/ophys.py b/docs/gallery/domain/ophys.py index f8f6da98a..3f42e6c14 100644 --- a/docs/gallery/domain/ophys.py +++ b/docs/gallery/domain/ophys.py @@ -86,12 +86,17 @@ # :align: center # # Create a :py:class:`~pynwb.device.Device` named ``"Microscope"`` in the :py:class:`~pynwb.file.NWBFile` object. Then -# create an :py:class:`~pynwb.ophys.OpticalChannel` named ``"OpticalChannel"``. +# create an :py:class:`~pynwb.ophys.OpticalChannel` named ``"OpticalChannel"``. The fields +# ``description``, ``manufacturer``, ``model_number``, ``model_name``, and ``serial_number`` are optional, but +# recommended. device = nwbfile.create_device( name="Microscope", description="My two-photon microscope", - manufacturer="The best microscope manufacturer", + manufacturer="Loki Labs", + model_number="ABC-123", + model_name="Loki 1.0", + serial_number="1234567890", ) optical_channel = OpticalChannel( name="OpticalChannel",