Clarify documentation for JetStreamSubscription #1400
Merged
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.
Fix javadoc for fetch() maxWait parameter
Problem
The current javadoc for the
maxWaitparameter in bothfetch()method overloads incorrectly states that it's "the maximum time to wait for the first message." This is misleading as it suggests the timeout only applies to receiving the initial message.Solution
Updated the parameter descriptions to clarify that
maxWait/maxWaitMillisis "the maximum time to wait to collect messages for the batch," which accurately reflects that the timeout governs the entire batch collection operation.Changes
@param maxWaitdescription in javadoc forfetch(int batchSize, Duration maxWait)method@param maxWaitMillisdescription in javadoc forfetch(int batchSize, long maxWaitMillis)methodThis change improves API documentation clarity for developers using JetStream pull subscriptions.