You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/06/27 01:50:43 UTC

[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16229: [Doc][Cli] Add explanations for topic retention policy.

Anonymitaet commented on code in PR #16229:
URL: https://github.com/apache/pulsar/pull/16229#discussion_r906911995


##########
pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopicPolicies.java:
##########
@@ -449,7 +449,8 @@ private class GetRetention extends CliCommand {
         private boolean applied = false;
 
         @Parameter(names = { "--global", "-g" }, description = "Whether to get this policy globally. "
-                + "If set to true, broker returned global topic policies")
+                + "If set to true, broker returned global topic policies"
+                + "If set to false or not set,the broker returned local topic policies")

Review Comment:
   ```suggestion
                   + "If set to true, the broker returns global topic policies"
                   + "If set to false or not set, the broker returns local topic policies")
   ```



##########
pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopicPolicies.java:
##########
@@ -449,7 +449,8 @@ private class GetRetention extends CliCommand {
         private boolean applied = false;
 
         @Parameter(names = { "--global", "-g" }, description = "Whether to get this policy globally. "
-                + "If set to true, broker returned global topic policies")
+                + "If set to true, broker returned global topic policies"
+                + "If set to false or not set,the broker returned local topic policies")

Review Comment:
   write in the simple present tense as much as possible if you are covering facts that were, are, and forever shall be true
   
   https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#bookmark=id.e8uqh1awkcnp



##########
pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopicPolicies.java:
##########
@@ -507,7 +509,8 @@ private class RemoveRetention extends CliCommand {
         private List<String> params;
 
         @Parameter(names = { "--global", "-g" }, description = "Whether to remove this policy globally. "
-                + "If set to true, the removing operation will be replicate to other clusters asynchronously")
+                + "If set to true, the removing operation will be replicate to other clusters asynchronously"

Review Comment:
   ```suggestion
                   + "If set to true, the removing operation is replicated to other clusters asynchronously"
   ```



##########
pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopicPolicies.java:
##########
@@ -474,7 +475,8 @@ private class SetRetention extends CliCommand {
         private String limitStr;
 
         @Parameter(names = { "--global", "-g" }, description = "Whether to set this policy globally. "
-                + "If set to true, the policy will be replicate to other clusters asynchronously")
+                + "If set to true, the policy will be replicate to other clusters asynchronously, "

Review Comment:
   ```suggestion
                   + "If set to true, the policy is replicated to other clusters asynchronously, "
   ```



-- 
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