Skip to content

Update documentation for heap ID and vlen data#6246

Open
mattjala wants to merge 1 commit intoHDFGroup:developfrom
mattjala:vlen-docs
Open

Update documentation for heap ID and vlen data#6246
mattjala wants to merge 1 commit intoHDFGroup:developfrom
mattjala:vlen-docs

Conversation

@mattjala
Copy link
Contributor

@mattjala mattjala commented Feb 26, 2026

Addresses #6233


Important

Update H5.format.4.0.dox to correct item size description and clarify Global Heap ID usage for variable-length data.

  • Documentation Updates:
    • Corrects item size description from 'L' to 'O' in H5.format.4.0.dox.
    • Adds note on additional fields preceding Global Heap IDs in data object storage for variable-length and reference data.
    • Clarifies storage of variable-length data in global heap, specifying 4-byte sequence length and Global Heap ID representation.

This description was created by Ellipsis for 2f2a4d2. You can customize this summary. It will automatically update as commits are pushed.

Copy link
Collaborator

@brtnfld brtnfld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes check out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component - Documentation Doxygen, markdown, etc.

Projects

Status: To be triaged

Development

Successfully merging this pull request may close these issues.

4 participants