Improve help messages #156
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
jobarr-amzn
approved these changes
Oct 21, 2024
Comment on lines
+30
to
+35
| .long_about("Print the analysis report of the input data stream, including the total number of\n\ | ||
| top-level values, their minimum, maximum, and mean sizes, and plot the size distribution of\n\ | ||
| the input stream. The report should also include the number of symbol tables in the input\n\ | ||
| stream, the total number of different symbols that occurred in the input stream, and the\n\ | ||
| maximum depth of the input data stream. Currently, this subcommand only supports data\n\ | ||
| analysis on binary Ion data.") |
There was a problem hiding this comment.
looks like a good use for indoc: https://github.com/dtolnay/indoc
There was a problem hiding this comment.
I don't know. I actually think that something like https://crates.io/crates/textwrap would be potentially more useful so that we don't have to worry about line wrapping any of our help text, but I'm saving that for another day.
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.
Issue #, if available:
Description of changes:
about, and along_about. This allows us to put the shorter one into the listing of subcommands and the longer one can go in the more detailed help.ion statsso that it wraps at a similar line length as the other commands.ion-cliif they are experiencing a problem with the CLI.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.