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

[Documentation]: request: tutorial on editing NWB files #1773

Open
3 tasks done
bendichter opened this issue Sep 6, 2023 · 3 comments
Open
3 tasks done

[Documentation]: request: tutorial on editing NWB files #1773

bendichter opened this issue Sep 6, 2023 · 3 comments
Assignees
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Milestone

Comments

@bendichter
Copy link
Contributor

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

@mavaylon1
Copy link
Collaborator

mavaylon1 commented Oct 29, 2023

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

@mavaylon1 mavaylon1 self-assigned this Oct 29, 2023
@mavaylon1
Copy link
Collaborator

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

@rly
Copy link
Contributor

rly commented Oct 29, 2023

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.

@stephprince stephprince added category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation labels Apr 12, 2024
@stephprince stephprince added this to the 2.8.0 milestone Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants