CLI Unification: Fix miscellaneous typos #1032
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brianstrauch
commented
Oct 4, 2021
brianstrauch
commented
Oct 4, 2021
| @@ -186,11 +186,11 @@ func NewKafkaProduceCommand(prerunner cmd.PreRunner) *cobra.Command { | |||
| }, | |||
| examples.Example{ | |||
| Text: "Produce Avro data to a topic called `mytopic5` in Confluent Cloud. Assumes topic has already been created, and Confluent Schema Registry is listening at `http://localhost:8081`.", | |||
| Code: `confluent local services kafka produce mytopic5 --cloud --config /tmp/myconfig.properties --value-format avro --property \\\nvalue.schema='{"type":"record","name":"myrecord","fields":[{"name":"f1","type":"string"}]}' \\\n--property schema.registry.url=http://localhost:8081`, | |||
There was a problem hiding this comment.
Oops. I think I wrote this as an intern.
mtodzo
approved these changes
Oct 4, 2021
| Example: examples.BuildExampleString( | ||
| examples.Example{ | ||
| Text: "List all mirrors in the cluster or under the given cluster link.", | ||
| Code: "ccloud kafka mirror list --link <link> --mirror-status <mirror-status>", | ||
| Text: "List all active mirror topics under `my-link`.", |
There was a problem hiding this comment.
That was my first thought too, but "mirror topics" is the right term: https://docs.confluent.io/platform/current/multi-dc-deployments/cluster-linking/mirror-topics-cp.html
| @@ -146,16 +145,16 @@ func (c *mirrorCommand) init() { | |||
| c.AddCommand(createCmd) | |||
|
|
|||
| promoteCmd := &cobra.Command{ | |||
| Use: "promote <destination-topic-1> <destination-topic-2> ... <destination-topic-N> --link <link>", | |||
| Short: "Promote the mirror topics.", | |||
| Use: "promote <destination-topic-1> <destination-topic-2> ... <destination-topic-N> --link my-link", | |||
There was a problem hiding this comment.
should we use the [] here for optional args?
There was a problem hiding this comment.
well i guess the first arg is required, so maybe <> is best
There was a problem hiding this comment.
Yeah, I think this way is good for now. Although in the future we should decide on a separate grammar for cases like this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
[CRUCIAL] Is the change for CP or CCloud functionalities that are already live in prod?
Did you add/update any commands that accept secrets as args/flags?
What
Fix a few miscellaneous typos found while testing the demo. I need to do a better job of unifying PRs once they're merged into
masterand thenmain.