Merge pull request #1400 from davidmorley/jetstream-subscription-docs-clarification

scottf · web-flow · commit fa20326e69bf · 2025-08-20T16:40:47.000-04:00
Clarify documentation for JetStreamSubscription
diff --git a/src/main/java/io/nats/client/JetStreamSubscription.java b/src/main/java/io/nats/client/JetStreamSubscription.java
@@ -133,7 +133,7 @@ public interface JetStreamSubscription extends Subscription {
      * ! Pull subscriptions only. Push subscription will throw IllegalStateException
      *
      * @param batchSize the size of the batch
-     * @param maxWait the maximum time to wait for the first message.
+     * @param maxWait the maximum time to wait to collect messages for the batch.
      *
      * @return the list of messages
      * @throws IllegalStateException if not a pull subscription.
@@ -148,7 +148,7 @@ public interface JetStreamSubscription extends Subscription {
      * ! Pull subscriptions only. Push subscription will throw IllegalStateException
      *
      * @param batchSize the size of the batch
-     * @param maxWaitMillis the maximum time to wait for the first message, in milliseconds.
+     * @param maxWaitMillis the maximum time to wait to collect messages for the batch, in milliseconds.
      *
      * @return the list of messages
      * @throws IllegalStateException if not a pull subscription.

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ public interface JetStreamSubscription extends Subscription {`
`133`	`133`	`* ! Pull subscriptions only. Push subscription will throw IllegalStateException`
`134`	`134`	`*`
`135`	`135`	`* @param batchSize the size of the batch`
`136`		`- * @param maxWait the maximum time to wait for the first message.`
	`136`	`+ * @param maxWait the maximum time to wait to collect messages for the batch.`
`137`	`137`	`*`
`138`	`138`	`* @return the list of messages`
`139`	`139`	`* @throws IllegalStateException if not a pull subscription.`
`@@ -148,7 +148,7 @@ public interface JetStreamSubscription extends Subscription {`
`148`	`148`	`* ! Pull subscriptions only. Push subscription will throw IllegalStateException`
`149`	`149`	`*`
`150`	`150`	`* @param batchSize the size of the batch`
`151`		`- * @param maxWaitMillis the maximum time to wait for the first message, in milliseconds.`
	`151`	`+ * @param maxWaitMillis the maximum time to wait to collect messages for the batch, in milliseconds.`
`152`	`152`	`*`
`153`	`153`	`* @return the list of messages`
`154`	`154`	`* @throws IllegalStateException if not a pull subscription.`