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

Improve text on LabMetaData extension #188

Open
rly opened this issue Mar 5, 2025 · 1 comment
Open

Improve text on LabMetaData extension #188

rly opened this issue Mar 5, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rly
Copy link
Contributor

rly commented Mar 5, 2025

From @h-mayorquin:

ChatGPT got the idea that a DynamicTable should be used to add extended metadata, even if the table has a single row.
This might have arisen from the note in https://nwb-overview.readthedocs.io/en/latest/extensions_tutorial/extension_examples/labmetadata_extension.html#approach

Image

which is not super clear.

I think it is bad practice to use a DynamicTable in this way because it's not a table, and it doesn't specify or validate data types. We discussed in our meeting that it may be better to provide an easy path for users to extend LabMetaData with simple, well-documented attributes (no groups, datasets, or links) for this use case. In the meantime, I think we should amend the above text to discourage use of DynamicTable in this way.

@rly rly added the documentation Improvements or additions to documentation label Mar 5, 2025
@oruebel
Copy link
Contributor

oruebel commented Mar 5, 2025

easy path for users to extend LabMetaData with simple, well-documented attributes (no groups, datasets, or links)

I realize that the following does not address this point, but it seems related. We have a step-by-step tutorial on how to create an extension of LabMetaData here https://nwb-overview.readthedocs.io/en/latest/extensions_tutorial/extension_examples/labmetadata_extension.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants