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.

Sign up for GitHub

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

Jump to bottom

Inconsistent behavior of get_name functions in documentation #4704

Closed
bmribler opened this issue Aug 9, 2024 · 0 comments · Fixed by #4715
Closed

Inconsistent behavior of get_name functions in documentation #4704

bmribler opened this issue Aug 9, 2024 · 0 comments · Fixed by #4715
Assignees
@bmribler
Labels
Component - C Library Core C library issues (usually in the src directory) Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Improvement Improvements that don't add a new feature or functionality

Comments

@bmribler
Copy link
Contributor

bmribler commented Aug 9, 2024 •
edited
Loading

Per the discussion in PR #4657, I looked through the get_name functions in the doxygen documentation develop. Below is a list of what is currently documented but is not yet confirmed in the code. I will do that and update the list.

  • Returns name/comment size without null terminator
    H5Fget_name
    H5Iget_name
    H5Oget_comment
    H5Oget_comment_by_name
    H5Rget_file_name
    H5Rget_obj_name
    H5Rget_name
    H5Rget_attr_name (fixed by PR Add tests for H5R get name APIs #4657)

Update documentation and/or tests
H5Aget_name
H5Aget_name_by_idx
H5Eget_class_name (improve test)
H5Lget_name_by_idx
H5Gget_comment (previously incorrect comment and documentation)

  • No size needed, library allocated and returned char*
    H5Tget_member_name

  • Typo needs to be fixed:

    • The second sentence should be "Up to (buf_size-1) characters..." in the following paragraph:
      "H5Aget_name() retrieves the name of an attribute specified by the identifier, attr_id. Up to buf_size characters are stored in buf followed by a \0 string terminator. If the name of the attribute is longer than (buf_size -1), the string terminator is stored in the last position of the buffer to properly terminate the string."
      Update: change this description to use alias so to word it consistently with other get_name functions.
@bmribler bmribler mentioned this issue Aug 9, 2024
Merged
@bmribler bmribler self-assigned this Aug 9, 2024
@bmribler bmribler added Priority - 1. High 🔼 These are important issues that should be resolved in the next release Component - C Library Core C library issues (usually in the src directory) Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality Priority - 2. Medium ⏹ It would be nice to have this in the next release and removed Priority - 1. High 🔼 These are important issues that should be resolved in the next release labels Aug 9, 2024
bmribler added a commit to bmribler/hdf5_bmr23 that referenced this issue Aug 15, 2024
@bmribler
Fix inconsistent documentation of get_name functions
b259967 
- Verified that the listed functions do not include null termintor in the returned length
- Improved some of the tests
- Corrected documentation

Fixes HDFGroupGH-4704
@bmribler bmribler mentioned this issue Aug 15, 2024
Merged
bmribler added a commit to bmribler/hdf5_bmr23 that referenced this issue Aug 19, 2024
@bmribler
Merge branch 'HDFGroupGH-4704' of https://github.com/bmribler/hdf5_bmr23
fe2879e 
 into HDFGroupGH-4704
@lrknox lrknox closed this as completed in 379a5ba Aug 23, 2024
lrknox pushed a commit to lrknox/hdf5 that referenced this issue Aug 27, 2024
@bmribler @lrknox
Fix inconsistent documentation of get_name functions (HDFGroup#4715)
c3444df 
- Verified that the listed functions do not include null terminator in the returned length
- Improved some of the tests
- Corrected documentation

Fixes HDFGroupGH-4704

* Casted a positive int to size_t
derobins added a commit that referenced this issue Aug 27, 2024
@lrknox @hyoklee
@ajelenak @bmribler @derobins @jhendersonHDF @mattjala
Sync develop changes August 21 - 27 to hdf5_1_14 (#4774)
e77c72e 
* Use gfortran 14 for cmake-ctest.yml on mac (#4739)

* Use gfortran 14 for cmake-test on mac

* Remove notarization step

* Address @byrnHDF review

* Fix enum type mismatch warning (#4741)

* Fix macro redefined warnings (#4744)

Removes a duplicated HDopen macro from the performance testing programs

* Update nvhpc CI version to 24.7 (#4740)

* Return basic HTTP range GET logging to ROS3 (#4738)

* Add minimal amount of S3 request logging to ROS3

* Fix ROS3 logging ifdef conditions

* Replace non-VOL calls with VOL calls - part 1 (#4745)

This PR is part of the incremental switching H5I_object() and H5I_object_verify()
to their VOL counterpart, H5VL_object() and H5VL_vol_object_verify(), a newly addedinternal function.

Fixes GH-4730 partially.

* Fix inconsistent documentation of get_name functions (#4715)

- Verified that the listed functions do not include null terminator in the returned length
- Improved some of the tests
- Corrected documentation

Fixes GH-4704

* Casted a positive int to size_t

* Remove HDF-EOS5 CI action (#4750)

The code can't be downloaded due to changes that put it behind an
EarthData login. We'll disable this while we figure out a work-around.

* Replace non-VOL calls with VOL calls - part 2 (#4748)

This PR switches H5I_object_verify() to H5VL_vol_object_verify() in the H5F API
and fixes documentation of H5Fmount and H5Funmount.

* More on H5F API

* Restore rand_r in a few parallel tests (#4749)

The t_pmulti_dset and t_select_io_dset tests rely on the behavior
of the previous private rand_r-like implementation to get the
correct sequence of random numbers to pass. This has been restored
using a fully private rand_r-like implementation that doesn't
rely on rand_r and will work on Windows and other platforms
where rand_r doesn't exist.

* Don't run AOCC parallel tests with -j2 (#4752)

Don't run parallel tests in both Autotools and CMake with multiple
processes. ph5diff still runs with -j2 w/ Autotools since the test
script is in the tools/test/h5diff directory.

* Split off AOCC CMake parallel tests

* Remove unnecessary NPROCS env vars

* Put NPROCS back in serial tests

We run ph5diff tests there

* Replace non-VOL calls with VOL calls - part 3 (#4756)

This PR switches H5I_object_verify() to H5VL_vol_object_verify() in the H5G API
and removes unnecessary casts.

* Turn on parallel CI tests in Autotools & CMake (#4573)

* Fix typo in H5Centry.c (#4762)

* Set/Unset VOL wrapping context in H5VL_attr_close (#4759)

* Add missing C++ and Fortran to Intel oneAPI CI (#4761)

* Add Fortran and C++ to Autotools
* Add Fortran and C++ to Linux CMake
* Add C++ to Windows CMake
* Fix bad GitHub workspace variable

* Remove early test exit (#4757)

* Don't skip file tests

* Remove test with invalid flag for H5Fopen

* Verify that create/open of unseekable file fails

* Remove failure verification

* Restore Julia CI (#4763)

Fixes #4539

* Capitalize f in (#4766)

* Add testing to NVHPC CI actions (CMake & Autotools) (#4760)

Turns on testing, both serial and parallel, but skips:
* dt_arith and dtransform in CMake
* All main library tests in the Autotools
Due to dt_arith and dtransform segfaults when handling long doubles.

* Fix typo in H5T_order_t enum (#4773)

'bit endian' --> 'big endian'

* Correct julia workflows name for hdf5_1_14 branch.

---------

Co-authored-by: H. Joe Lee <[email protected]>
Co-authored-by: Aleksandar Jelenak <[email protected]>
Co-authored-by: bmribler <[email protected]>
Co-authored-by: Dana Robinson <[email protected]>
Co-authored-by: jhendersonHDF <[email protected]>
Co-authored-by: mattjala <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bmribler bmribler

Labels
Component - C Library Core C library issues (usually in the src directory) Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix inconsistent documentation of get_name functions bmribler/hdf5_bmr23
1 participant
@bmribler