Improve Documentation: State on OOO-Commits page that AsyncAcks cannot be combined with nack() #2905
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
powibol
changed the title
garyrussell
approved these changes
Nov 20, 2023
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.
This PR adds a note to the documentation page about
asyncAckstating that it cannot be combined withAcknowledgment.nack().It was discussed in issue #2410, that
Acknowledgment.nack()cannot be used whenasyncAckset totrue.This was ensured with : Disallow nack() with Out of Order Commits.
It was also documented at several places, e.g., with this commit: : Disallow nack() with Out of Order Commits.
However, it is not mentioned on the documentation page about out-of-order commits and
asyncAcksthat this cannot be combined withnack(). This note is important, because if a user plans to setasyncAckstotrue, he should be made aware thatAcknowledgment.nack()must not be used.This note would have saved us some time. It would be great to see it added to the documentation.