MINOR: Improve JavaDoc for LEAVING state transition in AbstractHeartbeatRequestManager #20964
+3
−3
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
…eatRequestManager
github-actions
bot
added
triage
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR improves the JavaDoc explaining the transition to MemberState.LEAVING in AbstractHeartbeatRequestManager.
The previous wording was grammatically unclear and made it difficult to understand when and why the leave-group heartbeat is sent. The updated JavaDoc clarifies that:
the member epoch is reset for the leave-group heartbeat, and
transitioning to MemberState.LEAVING ensures that the next heartbeat notifies the coordinator that the member is leaving the group.