pynwb icon indicating copy to clipboard operation
pynwb copied to clipboard

[Documentation]: Improve documentation of idx_start and count in IntracellularRecordingsTable

Open oruebel opened this issue 1 year ago • 0 comments

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

Participants at the 2022 NWB User Days indicated that documentation for the fields idx_start and count could be improved in the context of intracellular electrophysiology. To address this issue I suggest:

  • Add a brief discussion and example of how to useidx_start and count to the Adding an intracellular recording section
  • Enhance the docstrings of the IntracellularRecordingsTable and corresponding sub-tables to discuss the default columns and the idx_start and count parameters

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

Yes.

Code of Conduct

oruebel avatar Aug 08 '22 07:08 oruebel