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:18:16 UTC
[GitHub] [pulsar] mattisonchao opened a new pull request, #16229: [Doc][Cli] Add explanations for topic retention policy.
mattisonchao opened a new pull request, #16229:
URL: https://github.com/apache/pulsar/pull/16229
Fixes #13617
Master Issue: #13617
### Motivation
See issue #13617
### Modifications
- Add explanations for topic retention policy.
### Verifying this change
- [x] Make sure that the change passes the CI checks.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `doc-not-needed`
(Please explain why)
- [x] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
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
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16229: [Doc][Cli] Add explanations for topic retention policy.
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [pulsar] michaeljmarshall commented on a diff in pull request #16229: [Doc][Cli] Add explanations for topic retention policy.
Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on code in PR #16229:
URL: https://github.com/apache/pulsar/pull/16229#discussion_r910611711
##########
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, the broker returns global topic policies"
Review Comment:
Nit: this line is missing a period and a trailing space. When the current annotation is output for the `bin/pulsar-admin topics` help command, it will have `policiesIf` instead of `policies. If`
##########
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 is replicated to other clusters asynchronously"
Review Comment:
Same comment.
--
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
[GitHub] [pulsar] Anonymitaet merged pull request #16229: [Doc][Cli] Add explanations for topic retention policy.
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #16229:
URL: https://github.com/apache/pulsar/pull/16229
--
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
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16229: [Doc][Cli] Add explanations for topic retention policy.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16229:
URL: https://github.com/apache/pulsar/pull/16229#discussion_r910730409
##########
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, the broker returns global topic policies"
Review Comment:
Nice catch!
--
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