Skip to content

Commit 96db85a

Browse files
Document HDF5 dataset fill value record
This record is available since 7a0d017 (Added fillValue parameter to the HDF5 file writer., 2015-09-22), but it was never properly documented. Document it under the metadata section as it is basically metadata regarding the default value the readers should read when no value is directly defined. This has been documented based on the corresponding explanation from the HDF5 library function [1] that uses this value, that is, H5Pset_fill_value(). [1] https://support.hdfgroup.org/documentation/hdf5/latest/group___d_c_p_l.html
1 parent 2ababaf commit 96db85a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/ADCore/NDFileHDF5.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -662,6 +662,12 @@ Parameters and Records
662662
- HDF5_dimAttDatasets
663663
- $(P)$(R)DimAttDatasets, $(P)$(R)DimAttDatasets_RBV
664664
- bo, bi
665+
* - asynFloat64
666+
- r/w
667+
- Fill value for the dataset to be set in its creation property list.
668+
- HDF5_fillValue
669+
- $(P)$(R)FillValue, $(P)$(R)FillValue_RBV
670+
- ao, ai
665671
* -
666672
-
667673
- **SWMR**

0 commit comments

Comments
 (0)