Addressed TODO documentation issues #6063
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brtnfld
requested review from
byrnHDF,
derobins,
fortnern,
jhendersonHDF and
lrknox
as code owners
brtnfld
requested review from
bmribler,
glennsong09,
mattjala,
qkoziol and
vchoi-hdfgroup
as code owners
hyoklee
reviewed
Nov 26, 2025
jhendersonHDF
previously approved these changes
Dec 5, 2025
* H5Smodule.h: Add dataspace selection and data transfer documentation * H5module.h: Add link types and organization documentation * H5Emodule.h: Add error handling programming model documentation
jhendersonHDF
previously approved these changes
Dec 5, 2025
jhendersonHDF
previously approved these changes
Dec 5, 2025
Collaborator
Author
|
@lrknox, waiting for your review |
lrknox
reviewed
Dec 8, 2025
src/H5ESmodule.h
Outdated
| * <tr> | ||
| * <th>H5R</th> | ||
| * <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region, #H5Rdereference | ||
| * <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region |
Collaborator
There was a problem hiding this comment.
Suggested change
| * <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region | |
| * <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region, |
Collaborator
Author
There was a problem hiding this comment.
comma should be after #H5Ropen_object
lrknox
previously approved these changes
Dec 8, 2025
lrknox
reviewed
Dec 8, 2025
jhendersonHDF
approved these changes
Dec 8, 2025
lrknox
approved these changes
Dec 8, 2025
github-project-automation
bot
moved this from In progress
to Done
in HDF5 - TRIAGE & TRACK
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #3105
Adds missing (i.e. todo) user guide documentation for:
Virtual File Drivers
VOL connectors
Map objects
Object interface, links, identifiers, filters
High-level APIs
Fixes #6050
Fixes table rendering issues.
Fixes #3006
Fix grammar in documentation block of H5FDioc.c and improve consistency.
Important
Added missing user guide documentation for various HDF5 components and fixed table rendering issues.
doxygen/dox/UsersGuide.dox.hl/src/H5DOpublic.h,hl/src/H5DSpublic.h,hl/src/H5IMpublic.h,hl/src/H5LTpublic.h,hl/src/H5PTpublic.h,hl/src/H5TBpublic.h,src/H5ESmodule.h,src/H5FDmodule.h,src/H5Imodule.h,src/H5Lmodule.h,src/H5Mmodule.h,src/H5Omodule.h,src/H5Pmodule.h,src/H5VLmodule.h, andsrc/H5Zmodule.hwith detailed sections on their respective functionalities.hl/src/H5DSpublic.h.This description was created by
for 8e7c960. You can customize this summary. It will automatically update as commits are pushed.