Skip to content

Commit 56a25a1

Browse files
authored
Merge pull request #196 from NeurodataWithoutBorders/copilot/improve-labmetadata-extension-text
Clarify LabMetaData guidance: discourage one-row DynamicTable usage
2 parents 0eccbc0 + 248174b commit 56a25a1

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/source/extensions_tutorial/extension_examples/labmetadata_extension.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ without having to modify the :py:class:`pynwb.file.NWBFile` type itself
2828

2929
NWB uses dynamically extensible table structures based on :py:class:`~hdmf.common.table.DynamicTable`
3030
to describe metadata and derived results, e.g., :py:class:`~pynwb.epochs.TimeIntervals` for epochs or trials
31-
or :py:class:`~pynwb.file.ElectrodeTable` to describe extracellular electrodes. Depending on the
32-
type of metadata, use of these existing dynamic table structures can help avoid the need for
33-
custom extensions by including the data as additional, custom columns in the appropriate existing tables.
31+
or :py:class:`~pynwb.file.ElectrodeTable` to describe extracellular electrodes.
32+
Use these table structures when your metadata are naturally tabular (i.e., multiple rows of similar records).
33+
For simple lab-specific metadata that are not tabular, avoid creating a one-row ``DynamicTable`` and
34+
instead define a :py:class:`~pynwb.file.LabMetaData` extension with explicit fields as shown below.
3435

3536
Creating the extension
3637
""""""""""""""""""""""
@@ -341,4 +342,3 @@ he main steps for publishing our extension. For a more in-depth guide, see the p
341342
of the source repositories for the extensions remain with the developers. For a step-by-step guide the
342343
:ref:`extension-publishing-ndxcatalog` guide.
343344

344-

0 commit comments

Comments
 (0)