feat: add user-friendly info to --help #884
Merged
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
--help
flag. The currentcommander
version (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 thatcommander
has 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.