CLI gen: only define about, not long_about#1380
Open
david-crespo wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Hand-written commands in the CLI will still have the 🤖 how hand-written commands in oxide.rs workEvery hand-written subcommand (
So e.g.
while |
This file contains hidden or 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
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.
Explanation in code comment. I was dismayed to learn that in our CLI,
-hand--helpdisplay different information. clap does this when you define bothaboutandlong_about. This PR stops doing that.A less invasive alternative would be to keep defining
aboutandlong_about, but include bothsummaryanddescriptioninlong_aboutinstead of justdescription. That would still be an improvement on the status quo, so I'd be in favor of it, but it does not fix the fact that-hand--helpdo different things, which to me is a little bizarre.Before
-hdisplays the short description,--helpdisplays the long one, but they are disjoint.After
The downside is we lose the cute listing of one-liners because the full descriptions get jammed in there. Personally I prefer this overall and I'm not sure more info in the list is necessarily a bad thing, but I can see how someone might disagree.