[GitHub] [pulsar] Anonymitaet commented on a change in pull request #12099: [Docs]Update docs for Client libraries Java

[GitBox <gi...@apache.org>]

Anonymitaet commented on a change in pull request #12099:
URL: https://github.com/apache/pulsar/pull/12099#discussion_r713555049



##########
File path: site2/docs/client-libraries-java.md
##########
@@ -143,7 +143,7 @@ Producer<byte[]> producer = client.newProducer()
 producer.send("My message".getBytes());
 ```
 
-By default, producers produce messages that consist of byte arrays. You can produce different types by specifying a message [schema](#schemas).
+By default, producers produce messages that consist of byte arrays. You can produce different types by specifying a message schema.

Review comment:
       ```suggestion
   By default, producers produce messages that consist of byte arrays. You can produce different types by specifying a message [schema](#schema).
   ```

##########
File path: site2/docs/client-libraries-java.md
##########
@@ -206,11 +206,11 @@ Producer<byte[]> producer = client.newProducer()
 
 ### Message routing
 
-When using partitioned topics, you can specify the routing mode whenever you publish messages using a producer. For more information on specifying a routing mode using the Java client, see the [Partitioned Topics](cookbooks-partitioned.md) cookbook.
+When using partitioned topics, you can specify the routing mode whenever you publish messages using a producer. For more information on specifying a routing mode using the Java client, see the [Partitioned Topics cookbook](cookbooks-partitioned.md).
 
 ### Async send
 
-You can publish messages [asynchronously](concepts-messaging.md#send-modes) using the Java client. With async send, the producer puts the message in a blocking queue and returns it immediately. Then the client library sends the message to the broker in the background. If the queue is full (max size configurable), the producer is blocked or fails immediately when calling the API, depending on arguments passed to the producer.
+You can publish messages [asynchronously](concepts-messaging.md#send-modes) using the Java client. With async send, the producer puts the message in a blocking queue and returns it immediately. Then the client library sends the message to the broker in the background. If the queue is full (max size configurable), the producer will be blocked or fail immediately when calling the API, depending on arguments passed to the producer.

Review comment:
       ```suggestion
   You can publish messages [asynchronously](concepts-messaging.md#send-modes) using the Java client. With async send, the producer puts the message in a blocking queue and returns it immediately. Then the client library sends the message to the broker in the background. If the queue is full (max size configurable), the producer is blocked or fails immediately when calling the API, depending on arguments passed to the producer.
   ```
   Use present tense in technical writing.

##########
File path: site2/docs/client-libraries-java.md
##########
@@ -101,34 +100,35 @@ PulsarClient client = PulsarClient.builder()
 
 If you create a client, you can use the `loadConf` configuration. The following parameters are available in `loadConf`.
 
-| Type | Name | <div style="width:260px">Description</div> | Default
+| Name | Type |  <div style="width:260px">Description</div> | Default
 |---|---|---|---
-String | `serviceUrl` |Service URL provider for Pulsar service | None
-String | `authPluginClassName` | Name of the authentication plugin | None
-String | `authParams` | String represents parameters for the authentication plugin <br/><br/>**Example**<br/> key1:val1,key2:val2|None
-long|`operationTimeoutMs`|Operation timeout |30000
-long|`statsIntervalSeconds`|Interval between each stats info<br/><br/>Stats is activated with positive `statsInterval`<br/><br/>Set `statsIntervalSeconds` to 1 second at least |60
-int|`numIoThreads`| The number of threads used for handling connections to brokers | 1 
-int|`numListenerThreads`|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for this subscription. This does not ensure ordering.| 1 
-boolean|`useTcpNoDelay`|Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-boolean |`useTls` |Whether to use TLS encryption on the connection| false
-string | `tlsTrustCertsFilePath` |Path to the trusted TLS certificate file|None
-boolean|`tlsAllowInsecureConnection`|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
-boolean | `tlsHostnameVerificationEnable` | Whether to enable TLS hostname verification|false
-int|`concurrentLookupRequest`|The number of concurrent lookup requests allowed to send on each broker connection to prevent overload on broker|5000
-int|`maxLookupRequest`|The maximum number of lookup requests allowed on each broker connection to prevent overload on broker | 50000
-int|`maxNumberOfRejectedRequestPerConnection`|The maximum number of rejected requests of a broker in a certain time frame (30 seconds) after the current connection is closed and the client creates a new connection to connect to a different broker|50
-int|`keepAliveIntervalSeconds`|Seconds of keeping alive interval for each client broker connection|30
-int|`connectionTimeoutMs`|Duration of waiting for a connection to a broker to be established <br/><br/>If the duration passes without a response from a broker, the connection attempt is dropped|10000
-int|`requestTimeoutMs`|Maximum duration for completing a request |60000
-int|`defaultBackoffIntervalNanos`| Default duration for a backoff interval | TimeUnit.MILLISECONDS.toNanos(100);
-long|`maxBackoffIntervalNanos`|Maximum duration for a backoff interval|TimeUnit.SECONDS.toNanos(30)
-SocketAddress|`socks5ProxyAddress`|SOCKS5 proxy address | None
-String|`socks5ProxyUsername`|SOCKS5 proxy username | None
-String|`socks5ProxyPassword`|SOCKS5 proxy password | None
+`serviceUrl` | String | Service URL provider for Pulsar service | None
+`authPluginClassName` | String | Name of the authentication plugin | None
+ `authParams` | String | String represents parameters for the authentication plugin <br/><br/>**Example**<br/> key1:val1,key2:val2|None
+`operationTimeoutMs`|long|`operationTimeoutMs`|Operation timeout |30000
+`statsIntervalSeconds`|long|Interval between each stats info<br/><br/>Stats is activated with positive `statsInterval`<br/><br/>Set `statsIntervalSeconds` to 1 second at least |60
+`numIoThreads`| int| The number of threads used for handling connections to brokers | 1 
+`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for this subscription. This does not ensure ordering.| 1 
+`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
+`useTls` |boolean |Whether to use TLS encryption on the connection| false
+ `tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
+`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
+`tlsHostnameVerificationEnable` |boolean |  Whether to enable TLS hostname verification|false
+`concurrentLookupRequest`|int|The number of concurrent lookup requests allowed to send on each broker connection to prevent overload on broker|5000
+`maxLookupRequest`|int|The maximum number of lookup requests allowed on each broker connection to prevent overload on broker | 50000
+`maxNumberOfRejectedRequestPerConnection`|int|The maximum number of rejected requests of a broker in a certain time frame (30 seconds) after the current connection is closed and the client creates a new connection to connect to a different broker|50
+`keepAliveIntervalSeconds`|int|Seconds of keeping alive interval for each client broker connection|30
+`connectionTimeoutMs`|int|Duration of waiting for a connection to a broker to be established <br/><br/>If the duration passes without a response from a broker, the connection attempt is dropped|10000
+`requestTimeoutMs`|int|Maximum duration for completing a request |60000
+`defaultBackoffIntervalNanos`|int| Default duration for a backoff interval | TimeUnit.MILLISECONDS.toNanos(100);
+`maxBackoffIntervalNanos`|long|Maximum duration for a backoff interval|TimeUnit.SECONDS.toNanos(30)
+`socks5ProxyAddress`|SocketAddress|SOCKS5 proxy address | None
+`socks5ProxyUsername`|string|SOCKS5 proxy username | None
+`socks5ProxyPassword`|string|SOCKS5 proxy password | None
+
 Check out the Javadoc for the {@inject: javadoc:PulsarClient:/client/org/apache/pulsar/client/api/PulsarClient} class for a full list of configurable parameters.
 
-> In addition to client-level configuration, you can also apply [producer](#configuring-producers) and [consumer](#configuring-consumers) specific configuration as described in sections below.
+> In addition to client-level configuration, you can also apply [producer](#Configure producer) and [consumer](#Configure consumer) specific configuration as described in sections below.

Review comment:
       ```suggestion
   > In addition to client-level configuration, you can also apply [producer](#configure-producer) and [consumer](#configure-consumer) specific configuration as described in sections below.
   ```




-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org