Update misleading contents in ConsumerPartitionPausedEvent and features.adoc #3293
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
bky373
changed the title
sobychacko
requested changes
Jun 3, 2024
| @@ -47,13 +48,13 @@ public ConsumerPartitionPausedEvent(Object source, Object container, TopicPartit | |||
| * Return the paused partition. | |||
| * @return the partition. | |||
| */ | |||
| public TopicPartition getPartitions() { | |||
| public TopicPartition getPartition() { | |||
There was a problem hiding this comment.
Since this is a public API, it might be better to deprecate this method, mark it for removal, and add the new one getPartition(). In a future version, we can completely remove this.
There was a problem hiding this comment.
Thanks for your comment! I just made a change and check it please.
sobychacko
requested changes
Jun 4, 2024
| /** | ||
| * Return the paused partition. | ||
| * @return the partition. | ||
| */ |
There was a problem hiding this comment.
Need the @since tag here.
There was a problem hiding this comment.
Oh Thanks for letting me know. I've added it.
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.
Changes
ConsumerPausedEvent->ConsumerPartitionPausedEvent(This prevents confusion with the existing eventConsumerPausedEvent).getPartitions()->getPartition()(Since the event is specific to a single partition, use the singular form)DeadLetterPublishingRecovererer->DeadLetterPublishingRecoverer