-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] Add descriptions for C++ API doc (ProducerConfiguration.h) #9822
Conversation
@BewareMyPower could you please help review? Thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jennifer88huang @Huanli-Meng could you please help review? Thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
leave my comments. PTAL
@Huanli-Meng thanks for your comments, I've incorporated them, PTAL. |
You need to format your code using Here's the diff you can diff --git a/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h b/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h
index c681461ab6a..085d342d763 100644
--- a/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h
+++ b/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h
@@ -229,8 +229,8 @@ class PULSAR_PUBLIC ProducerConfiguration {
*/
const MessageRoutingPolicyPtr& getMessageRouterPtr() const;
- /**
- * Set the hashing scheme, which is a standard hashing function available when choosing the partition
+ /**
+ * Set the hashing scheme, which is a standard hashing function available when choosing the partition
* used for a particular message.
*
* <p>Standard hashing functions available are:
@@ -269,10 +269,10 @@ class PULSAR_PUBLIC ProducerConfiguration {
* Control whether automatic batching of messages is enabled or not for the producer. <i>Default value:
* false (no automatic batching).</i>
*
- * When automatic batching is enabled, multiple calls to Producer::sendAsync can result in a single batch to be sent
- * to the broker, leading to better throughput, especially when publishing small messages. If compression
- * is enabled, messages are compressed at the batch level, leading to a much better compression ratio for
- * similar headers or contents.
+ * When automatic batching is enabled, multiple calls to Producer::sendAsync can result in a single batch
+ * to be sent to the broker, leading to better throughput, especially when publishing small messages. If
+ * compression is enabled, messages are compressed at the batch level, leading to a much better
+ * compression ratio for similar headers or contents.
*
* When the default batch delay is set to 10 ms and the default batch size is 1000 messages.
* |
@BewareMyPower many thanks for your guidance! Previously I used the |
Add docs for #9282, which fix the issue partly.