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

Reference Manual needs to provide a direct access to API Compatibility Macros #3520

Closed
bmribler opened this issue Sep 7, 2023 · 3 comments
Closed

Reference Manual needs to provide a direct access to API Compatibility Macros #3520

bmribler opened this issue Sep 7, 2023 · 3 comments
Assignees
@derobins @bmribler @byrnHDF
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Improvement Improvements that don't add a new feature or functionality
Milestone
1.14.4

Comments

@bmribler
Copy link
Contributor

bmribler commented Sep 7, 2023

Currently, accessing API compatibility macros such as H5Literate is not at all obvious.
Consider adding a doxygen table or something that lists the APIs and point to the "API Compatibility Macros " link.
@bmribler bmribler added Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality Branch - 1.10 labels Sep 7, 2023
@byrnHDF
Copy link
Contributor

byrnHDF commented Sep 11, 2023

Turns out that there already is a link at the top of the H5L module called "Link Traversal"

@byrnHDF
Copy link
Contributor

byrnHDF commented Sep 11, 2023

Added a small note that indicates what functions are located in a subgroup of the H5L module. See #3530.

@derobins derobins added this to the 1.14.3 milestone Oct 4, 2023
@derobins derobins modified the milestones: 1.14.3, 1.14.4 Oct 24, 2023
@derobins derobins added Priority - 1. High 🔼 These are important issues that should be resolved in the next release and removed Branch - 1.14 labels Jan 23, 2024
@byrnHDF
Copy link
Contributor

byrnHDF commented Mar 4, 2024

#3530 addressed this issue

@byrnHDF byrnHDF closed this as completed Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@derobins derobins

@bmribler bmribler

@byrnHDF byrnHDF

Labels
Component - Documentation Doxygen, markdown, etc. Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Milestone
1.14.4
Development

No branches or pull requests
3 participants
@derobins @bmribler @byrnHDF