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

Improve documentation for callbacks #5089

Closed
bmribler opened this issue Nov 12, 2024 · 1 comment
Closed

Improve documentation for callbacks #5089

bmribler opened this issue Nov 12, 2024 · 1 comment
Assignees
@bmribler
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
2.0.0

Comments

@bmribler
Copy link
Contributor

As described in GH-5080 and, more detail, in SUPPORT-2143, the documentation should be more clear about callback functions needing to avoid throwing an exception that is not handled in the callback.
@bmribler bmribler self-assigned this Nov 12, 2024
@bmribler bmribler added Priority - 1. High 🔼 These are important issues that should be resolved in the next release Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Nov 12, 2024
bmribler added a commit to bmribler/hdf5_bmr23 that referenced this issue Nov 17, 2024
@bmribler
Added note about leaving callback functions properly.
b3d7ffa 
Added the alias \callback_note to APIs with a user callback function.  The note is
brief and refers to a more detail note in a central place, i.e., alias cpp_c_api_note.

Fixes issue HDFGroupGH-5089
@bmribler bmribler mentioned this issue Nov 17, 2024
Merged
derobins pushed a commit that referenced this issue Nov 18, 2024
@bmribler
Added note about leaving callback functions properly. (#5127)
dc4bdad 
Added the alias \callback_note to APIs with a user callback function.  The note is
brief and refers to a more detail note in a central place, i.e., alias cpp_c_api_note.

Fixes issue GH-5089
@derobins derobins added this to the 2.0.0 milestone Nov 18, 2024
@derobins
Copy link
Member

Fixed in #5127

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

@bmribler bmribler

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
2.0.0
Development

No branches or pull requests
2 participants
@derobins @bmribler