Update documentation

bmribler · Aug 12, 2024 · da125e2 · da125e2
1 parent 8be015a
commit da125e2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
@@ -811,6 +811,15 @@ Bug Fixes since HDF5-1.14.0 release
 ===================================
     Library
     -------
+    - Fixed H5Rget_attr_name to return the length of the attribute's name
+      without the null terminator
+
+      H5Rget_file_name and H5Rget_obj_name both return the name's length
+      without the null termintor.  H5Rget_attr_name now behaves consistently
+      with the other two APIs.  Going forward, all the get character string
+      APIs in HDF5 will be modified/written in this manner, regarding the
+      length of a character string.
+
     - Fixed library to allow usage of page buffering feature for serial file
       access with parallel builds of HDF5
 

diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h
@@ -589,7 +589,7 @@ H5_DLL ssize_t H5Rget_obj_name(H5R_ref_t *ref_ptr, hid_t rapl_id, char *name, si
  * \details H5Rget_attr_name() retrieves the attribute name for the
  *          attribute reference pointed to by \p ref_ptr.
  *
- *          \details_namelen_plusone{attribute,H5Rget_attr_name}
+ *          \details_namelen{attribute,H5Rget_attr_name}
  *
  * \since 1.12.0
  *