From cc89e0c192fbbddee4b9246e59555fadb6957402 Mon Sep 17 00:00:00 2001 From: Caleb Epstein Date: Fri, 21 Aug 2020 10:44:27 -0400 Subject: [PATCH] Some clarification of docs for partition and ordering key (#7745) Motivation As a Pulsar newbie, the role of "partition key" and "ordering key" aren't entirely clear from the Doxygen comments. These names are not used in the public Pulsar documentation that I saw, so expanding the comments felt useful to me and may help other users. Modifications Expanded doc strings for MessageBuilder.setPartitionKey and setOrderingKey Verifying this change This change is a trivial rework / code cleanup without any test coverage. Documentation This change improves the C++ Doxygen output. --- pulsar-client-cpp/include/pulsar/MessageBuilder.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pulsar-client-cpp/include/pulsar/MessageBuilder.h b/pulsar-client-cpp/include/pulsar/MessageBuilder.h index a71b640a9fe..e1be9166ec1 100644 --- a/pulsar-client-cpp/include/pulsar/MessageBuilder.h +++ b/pulsar-client-cpp/include/pulsar/MessageBuilder.h @@ -64,13 +64,13 @@ class PULSAR_PUBLIC MessageBuilder { MessageBuilder& setProperties(const StringMap& properties); /** - * set partition key for the message routing + * set partition key for message routing and topic compaction * @param hash of this key is used to determine message's topic partition */ MessageBuilder& setPartitionKey(const std::string& partitionKey); /** - * set ordering key for the message routing + * set ordering key used for key_shared subscriptions * @param the ordering key for the message */ MessageBuilder& setOrderingKey(const std::string& orderingKey); -- GitLab