[Documentation]: Add documentation clarifying HDMF as an important PyNWB dependency #2034
Open
3 tasks done
Labels
category: enhancement
improvements of code or code behavior
priority: low
alternative solution already working and/or relevant to only specific user(s)
topic: docs
issues related to documentation
topic: HDMF
issues related to the use, depending on, or affecting HDMF
What would you like changed or added to the documentation and why?
Currently it is not obvious from the main installation documentation pages that hdmf is an important dependency for pynwb functioning and that the two packages are closely related. If a user pins a specific pynwb version, they may not realize it is important to also pin the hdmf version. This came up most recently in #2030.
I propose we add a note to the installation documentation about hdmf as an important dependency, including any major hdmf/pynwb version compatibility requirements.
Another option to consider in the future is to more tightly couple pynwb and hdmf so that each version of pynwb requires a specific version of hdmf, but that can be opened as a separate issue if it continues to be a concern.
Do you have any interest in helping write or edit the documentation?
Yes.
Code of Conduct
The text was updated successfully, but these errors were encountered: