KAFKA-19060 Documented null edge cases in the Clients API JavaDoc #19393
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
github-actions
bot
added
triage
Yunyung
reviewed
Apr 7, 2025
| @@ -1658,7 +1660,8 @@ public Map<TopicPartition, Long> beginningOffsets(Collection<TopicPartition> par | |||
| * @see #seekToEnd(Collection) | |||
| * | |||
| * @param partitions the partitions to get the end offsets. | |||
| * @return The end offsets for the given partitions. | |||
| * @return The end offsets for the given partitions. If the offset for a specific partition cannot be found or the | |||
| * timeout is zero, the corresponding value will be {@code null} | |||
There was a problem hiding this comment.
Some paragraphs have periods, while others do not, for existing JavaDocs. I think we could make them all consistent (this can be addressed in another PR).
There was a problem hiding this comment.
Sure, but I won't address this changes in this PR.
|
Hello @kirktrue, if you have free cycle, PTAL |
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.
Some client APIs may return
nullvalues in the map, but thisbehaviorisn’t documented in the JavaDoc. We should update the JavaDoc to
include these edge cases.
These method have been modified.