docs: Unify style of CLI arguments #1050
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
Update CLI option examples from 2 leading dashes to just 1.
|
Thank you for the PR, but what is your motivation behind this? Go's flag parser supports options being supplied with two and just one dash. So the examples are correct AFAIK. |
|
Ah okay. I don't know much about go yet. I had noticed that So with that, now I think for sake of consistency it would be nice to align it. |
|
Thanks for this! I just saw that we also use single dashes in the majority of our documentation, so I agree that we should keep it consistent :) |
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.
Update CLI option examples from 2 leading dashes to just 1.