pynwb icon indicating copy to clipboard operation
pynwb copied to clipboard

[Documentation]: request: tutorial on editing NWB files

Open bendichter opened this issue 1 year ago • 3 comments

What would you like changed or added to the documentation and why?

I'd like a tutorial that steps the user through the different use-cases of how to edit an NWB file.

  1. changing the value of a dataset
  2. changing the value of an attribute
  3. overwriting a dataset
  4. anything else

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

bendichter avatar Sep 06 '23 16:09 bendichter

Agreed. I'll take this on because I would also like this clearly demonstrated.

mavaylon1 avatar Oct 29 '23 01:10 mavaylon1

@bendichter What about an expansion to the export tutorial? @rly Thoughts?

mavaylon1 avatar Oct 29 '23 01:10 mavaylon1

I agree - this is important.

Because I was curious about attributes, I did some tests here a little bit ago: https://gist.github.com/rly/be7bee420b482b9ddcd084f57cc4115e

I think this could expand the export tutorial but should be structured like @bendichter mentions. A user comes in and wants to change X. They should be able to scan through a table of contents and get to a section that tells them exactly what they should do.

rly avatar Oct 29 '23 05:10 rly