Skip to content

Commit

Permalink
Add note to H5Tset_fields about needing to set datatype precision first
Browse files Browse the repository at this point in the history
  • Loading branch information
jhendersonHDF authored Mar 4, 2024
1 parent f86fe61 commit 55895af
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/H5Tpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -2568,6 +2568,12 @@ H5_DLL herr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign);
* Fields are not allowed to extend beyond the number of bits of
* precision, nor are they allowed to overlap with one another.
*
* \note The size and precision of the floating-point datatype should be set
* appropriately before calling H5Tset_fields(). Otherwise, H5Tset_fields()
* may fail when checking that the values make sense for the datatype.
* This is of particular concern if another floating-point datatype was
* copied as a starting point.
*
* \since 1.0.0
*
*/
Expand Down

0 comments on commit 55895af

Please sign in to comment.