Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance LabMetaData docstring #1546

Merged
merged 6 commits into from
Sep 1, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/pynwb/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,20 @@ def _not_parent(arg):

@register_class('LabMetaData', CORE_NAMESPACE)
class LabMetaData(NWBContainer):
"""Container for storing lab-specific meta-data"""
"""
Container for storing lab-specific meta-data

The LabMetaData class serves as a base type for defining lab specific meta-data.
To define your own lab-specific metadata, create a Neurodata Extension (NDX) for
NWB that defines the data to add. Using the LabMetaData container as a base type
makes it easy to add your data to an NWBFile without having to modify the NWBFile
type itself, since adding of LabMetaData is already implemented. This allows
extensions based on LabMetaData to be typically fairly simple and helps avoid the
need for custom Container classes in many cases. For more details
on how to create an extension see the
:nwb_overview:`Extending NWB <extensions_tutorial/extensions_tutorial_home.html>`
oruebel marked this conversation as resolved.
Show resolved Hide resolved
tutorial.
"""

@docval({'name': 'name', 'type': str, 'doc': 'name of lab metadata'})
def __init__(self, **kwargs):
Expand Down