Fix issues in documentation of topic-pattern parameter (apache#16960)

merlimat · Aug 16, 2022 · d861dc5 · d861dc5
1 parent 3480ba5
commit d861dc5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
@@ -228,10 +228,10 @@ abstract class FunctionDetailsCommand extends BaseCommand {
                 + "Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)",
                 hidden = true)
         protected String deprecatedTopicsPattern;
-        @Parameter(names = "--topics-pattern", description = "The topic pattern to consume from list of topics "
-                + "under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. "
-                + "Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)"
-                + " #Java, Python")
+        @Parameter(names = "--topics-pattern", description = "The topic pattern to consume from a list of topics "
+                + "under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually "
+                + "exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java "
+                + "functions only) #Java, Python")
         protected String topicsPattern;
 
         @Parameter(names = {"-o", "--output"},

diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdSinks.java
@@ -301,9 +301,9 @@ abstract class SinkDetailsCommand extends BaseCommand {
                 + "Add SerDe class name for a pattern in --customSerdeInputs  (supported for java fun only)",
                 hidden = true)
         protected String deprecatedTopicsPattern;
-        @Parameter(names = "--topics-pattern", description = "TopicsPattern to consume from list of topics "
-                + "under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. "
-                + "Add SerDe class name for a pattern in --customSerdeInputs  (supported for java fun only)")
+        @Parameter(names = "--topics-pattern", description = "The topic pattern to consume from a list of topics "
+                + "under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually "
+                + "exclusive. Add SerDe class name for a pattern in --custom-serde-inputs")
         protected String topicsPattern;
 
         @Parameter(names = "--subsName", description = "Pulsar source subscription name "

diff --git a/site2/docs/io-cli.md b/site2/docs/io-cli.md
@@ -401,7 +401,7 @@ $ pulsar-admin sinks create options
 | `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
 | `--tenant` | The sink's tenant.
 | `--timeout-ms` | The message timeout in milliseconds.
-| `--topics-pattern` | TopicsPattern to consume from list of topics under a namespace that match the pattern. <br />`--input` and `--topics-Pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--customSerdeInputs` (supported for java fun only).
+| `--topics-pattern` | The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br />`--input` and `--topics-pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--custom-serde-inputs`.
 
 ### `update`
 
@@ -439,7 +439,7 @@ $ pulsar-admin sinks update options
 | `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
 | `--tenant` | The sink's tenant.
 | `--timeout-ms` | The message timeout in milliseconds.
-| `--topics-pattern` | TopicsPattern to consume from list of topics under a namespace that match the pattern. <br />`--input` and `--topics-Pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--customSerdeInputs` (supported for java fun only).
+| `--topics-pattern` | The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br />`--input` and `--topics-pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--custom-serde-inputs`.
 | `--update-auth-data` | Whether or not to update the auth data.<br />**Default value: false.**
 
 ### `delete`
@@ -634,7 +634,7 @@ $ pulsar-admin sinks localrun options
 | `--negative-ack-redelivery-delay-ms` | The negatively-acknowledged message redelivery delay in milliseconds. |
 |`--tls-allow-insecure`|Allow insecure tls connection.<br />**Default value: false**.
 |`--tls-trust-cert-path`|The tls trust cert file path.
-| `--topics-pattern` | TopicsPattern to consume from list of topics under a namespace that match the pattern. <br />`--input` and `--topics-Pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--customSerdeInputs` (supported for java fun only).
+| `--topics-pattern` | The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br />`--input` and `--topics-pattern` are mutually exclusive. <br />Add SerDe class name for a pattern in `--custom-serde-inputs`.
 |`--use-tls`|Use tls connection.<br />**Default value: false**.
 
 ### `available-sinks`