Add doc to H5DataIO.dataset setter #1154
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
While reading through the code for
H5DataIO
, I was confused about the purpose of thedataset
property and how it differs fromdata
since it is not used locally:hdmf/src/hdmf/backends/hdf5/h5_utils.py
Lines 545 to 555 in dfb1df7
It turns out
dataset
was added for a very specific use case where a user wants to create an empty hdf5 dataset, write it to disk, and have access to the handle to that dataset without having to close and reopen the file -- #747To prevent myself and others from retracing those steps to understand this code, I added a docstring.
Checklist
CHANGELOG.md
with your changes?