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]: Add documentation clarifying HDMF as an important PyNWB dependency #2034

Open
3 tasks done
stephprince opened this issue Feb 7, 2025 · 0 comments
Open
3 tasks done
Assignees
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

Comments

@stephprince
Copy link
Contributor

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

@stephprince stephprince self-assigned this Feb 7, 2025
@stephprince stephprince added category: enhancement improvements of code or code behavior topic: docs issues related to documentation topic: HDMF issues related to the use, depending on, or affecting HDMF priority: low alternative solution already working and/or relevant to only specific user(s) labels Feb 7, 2025
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: 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
Projects
None yet
Development

No branches or pull requests

1 participant