search

NeurodataWithoutBorders / pynwb

A Python API for working with Neurodata stored in the NWB Format
https://pynwb.readthedocs.io
Other
175 stars 85 forks source link

[Documentation]: function docstrings not rendering properly for `pynwb.file module` #1444

Closed h-mayorquin closed 2 years ago

h-mayorquin commented 2 years ago

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

There seems to be some problem as the docstrings are not rendered properly: https://pynwb.readthedocs.io/en/stable/pynwb.file.html#pynwb.file.NWBFile.add_unit_column

The documentation seems to break at the description of index:

Untitled drawing (1)

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

No.

Code of Conduct

oruebel commented 2 years ago

Looking at code, I believe this is actually a problem inherited from HDMF DynamicaTable.add_column. I'll open a corresponding issue on HDMF and close this one in favor of that one.

oruebel commented 2 years ago

I've created a new issue for this on the HDMF repo since this issue needs to be fixed in HDMF. The new issue is here https://github.com/hdmf-dev/hdmf/issues/711 I'm closing this issue for now as this will get fixed automatically once that issue is complete.