feat: add user-friendly info to --help#884
Merged
joaomoreno merged 6 commits intomicrosoft:mainfrom Aug 30, 2023
Merged
Conversation
joaomoreno
requested changes
Aug 25, 2023
Member
joaomoreno
left a comment
There was a problem hiding this comment.
Please undo the whitespace changes. Also remove the huge non-user-friendly ASCII art.
e564bdb to
b67fad3
Compare
joaomoreno
previously approved these changes
Aug 30, 2023
joaomoreno
approved these changes
Aug 30, 2023
hediet
approved these changes
Aug 30, 2023
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
3 participants
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.
Resolves #769
Description
This PR adds basic user-friendly message as a description, which is expected to appear at every command passed with the
--helpflag. The currentcommanderversion (6.1.0) doesn't support certain commands that help adding this message properly (like only for the 'root' help), as well as other commands that potentially can be helpful in optimizing the current code and removing the parts thatcommanderhas implemented under-the-hood (like showing suggestions on errors).So I would highly suggest creating an issue to proceed with migration to version 8.2.0 at least. And I would love to help you with that migration.