Update CLI help messages. #146
Open
+66
−67
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
mvadari
reviewed
Oct 4, 2023
| @@ -52,26 +52,26 @@ | |||
| "--name", | |||
| required=True, | |||
| prompt=True, | |||
| help="The name of the bridge (used for differentiation purposes).", | |||
There was a problem hiding this comment.
Why are these all changed to be action statements?
There was a problem hiding this comment.
Active voice is preferred for documentation--even with CLI help messages as far as I'm aware?
mvadari
reviewed
Oct 26, 2023
mvadari
reviewed
Oct 26, 2023
mvadari
reviewed
Oct 26, 2023
Co-authored-by: Mayukha Vadari <mvadari@gmail.com>
Co-authored-by: Mayukha Vadari <mvadari@gmail.com>
Co-authored-by: Mayukha Vadari <mvadari@gmail.com>
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.
High Level Overview of Change
Cleaned up help messages.