Add additional documentation for nested callbacks #2635
Merged
+30
−2
Conversation
This file contains 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
|
@jpallas LMK if this the level of documentation that works for you. I still would be interested in possible lockup / error scenarios. |
|
stevenschlansker
approved these changes
Feb 17, 2024
|
This is a really helpful improvement. Thank you! The only suggestion I have is to make some mention of handle reuse in the Javadoc for these methods. IDEs will display Javadoc but don't know about the external documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@jpallas pointed out in #2633 that our documentation about nesting
callbacks with managed handles is incomplete and confusing.
Add a chapter about nested callback, call out the limitations, add
references to the managed handle and managed transaction chapters.