forked from Backblaze/B2_Command_Line_Tool
-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Display short description from docstring instead of params in usage #290
Merged
mjurbanski-reef
merged 8 commits into
reef-technologies:master
from
olzhasar-reef:olzhasar/hide-params-in-help
May 8, 2024
Merged
Display short description from docstring instead of params in usage #290
mjurbanski-reef
merged 8 commits into
reef-technologies:master
from
olzhasar-reef:olzhasar/hide-params-in-help
May 8, 2024
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
olzhasar-reef
changed the title
Use short description from docstring as usage help
Display short description from docstring instead of params in usage help
May 7, 2024
olzhasar-reef
changed the title
Display short description from docstring instead of params in usage help
Display short description from docstring instead of params in usage
May 7, 2024
mjurbanski-reef
suggested changes
May 7, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
usages:
b2 account Account management subcommands.
b2 bucket Bucket management subcommands.
b2 file File management subcommands.
b2 info Prints all of the information about the object, but not its contents.
b2 install-autocomplete Installs autocomplete for supported shells.
b2 key Application keys management subcommands.
b2 license Prints the license of B2 Command line tool and all libraries shipped with it.
b2 ls Using the file naming convention that / separates folder names from their contents, returns
b2 replication Replication rule management subcommands.
b2 rm Removes a "folder" or a set of files matching a pattern. Use with caution.
b2 sync Copies multiple files from source to destination. Optionally deletes or hides destination
b2 version Prints the version number of this tool.
This looks almost good, but:
- its hard to determine where command ends and where description beings - ideally all would be aligned as they are in git, i.e.
bisect Use binary search to find the commit that introduced a bug
diff Show changes between commits, commit and working tree, etc
grep Print lines matching a pattern
log Show commit logs
show Show various types of objects
status Show the working tree status
or perhaps otherwise clearly marked where command ends
b2 ls Using the file naming convention that / separates folder names from their contents, returns
- something went very wrong here, same withsync
- missing towncrier changelog msg
I changed a lot of docstrings to use imperative verb form in the first line. This form arguably better fits the cli help context: more concise and straight to the point. |
mjurbanski-reef
approved these changes
May 7, 2024
mjurbanski-reef
approved these changes
May 8, 2024
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.
No description provided.