tisonkun commented on code in PR #18809:
URL: https://github.com/apache/pulsar/pull/18809#discussion_r1044073449
##########
pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ProducerBuilder.java:
##########
@@ -275,15 +275,16 @@
/**
* Set the compression type for the producer.
*
- * <p>By default, message payloads are not compressed. Supported
compression types are:
+ * <p>By default, message payloads are not compressed.
+ * <p>Supported compression types are:
* <ul>
- * <li>{@link CompressionType#NONE}: No compression (Default)</li>
- * <li>{@link CompressionType#LZ4}: Compress with LZ4 algorithm. Faster
but lower compression than ZLib</li>
- * <li>{@link CompressionType#ZLIB}: Standard ZLib compression</li>
- * <li>{@link CompressionType#ZSTD} Compress with Zstandard codec. Since
Pulsar 2.3. Zstd cannot be used if consumer
- * applications are not in version >= 2.3 as well</li>
- * <li>{@link CompressionType#SNAPPY} Compress with Snappy codec. Since
Pulsar 2.4. Snappy cannot be used if
- * consumer applications are not in version >= 2.4 as well</li>
+ * <li>{@link CompressionType#NONE}: No compression (default)</li>
+ * <li>{@link CompressionType#LZ4}: Compress with LZ4 algorithm. Faster
but lower compression than ZLib.</li>
+ * <li>{@link CompressionType#ZLIB}: Standard ZLib compression.</li>
+ * <li>{@link CompressionType#ZSTD} Compress with Zstandard codec. Since
Pulsar 2.3, Zstandard can only be used
Review Comment:
```suggestion
* <li>{@link CompressionType#ZSTD} Compress with Zstd codec. Since
Pulsar 2.3, Zstd can only be used
```
This should be a famous abbr.
##########
pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ProducerBuilder.java:
##########
@@ -164,37 +164,37 @@
ProducerBuilder<T> sendTimeout(int sendTimeout, TimeUnit unit);
/**
- * Set the max size of the queue holding the messages pending to receive
an acknowledgment from the broker.
+ * Set the max size of the messages pending queue to receive an
acknowledgment from the broker.
Review Comment:
```suggestion
* Set the max size of the queue holding the messages pending to receive
an acknowledgment from the broker.
```
Revert. Not quite different.
##########
pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ProducerBuilder.java:
##########
@@ -164,37 +164,37 @@
ProducerBuilder<T> sendTimeout(int sendTimeout, TimeUnit unit);
/**
- * Set the max size of the queue holding the messages pending to receive
an acknowledgment from the broker.
+ * Set the max size of the messages pending queue to receive an
acknowledgment from the broker.
*
* <p>When the queue is full, by default, all calls to {@link
Producer#send} and {@link Producer#sendAsync}
* will fail unless {@code blockIfQueueFull=true}. Use {@link
#blockIfQueueFull(boolean)}
* to change the blocking behavior.
*
* <p>The producer queue size also determines the max amount of memory
that will be required by
- * the client application. Until, the producer gets a successful
acknowledgment back from the broker,
+ * the client application. Until the producer gets a successful
acknowledgment back from the broker,
* it will keep in memory (direct memory pool) all the messages in the
pending queue.
*
- * <p>Default is 0, disable the pending messages check.
+ * <p>Default is 0, which disables the pending messages check.
*
* @param maxPendingMessages
- * the max size of the pending messages queue for the producer
+ * the max size of the messages pending queue for the producer
Review Comment:
```suggestion
* the max size of the pending messages queue for the producer
```
This should be the idiom phrase and also the method is named
`maxPendingMessages `
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
