feat: switching from usage to help documentation by default #943
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
ghost
requested review from
3 tasks
lili2311
force-pushed
the
jdewinne-help-vs-usage
branch
2 times, most recently
from
b43520d
to
336614c
Compare
gitphill
reviewed
Jan 7, 2020
lili2311
force-pushed
the
jdewinne-help-vs-usage
branch
from
336614c
to
9b327c8
Compare
lili2311
force-pushed
the
jdewinne-help-vs-usage
branch
from
9b327c8
to
91533ad
Compare
gitphill
approved these changes
Jan 7, 2020
|
🎉 This PR is included in version 1.277.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
What does this PR do?
The current
snykcli shows ausage.txthelp file when no command is given. Thatusage.txtfile points to executingsnyk --helpto get more information in the usage. This PR simplifies that and directly showshelpWhere should the reviewer start?
Run
snykand see if thehelp.txtis displayed by defaultHow should this be manually tested?
Executing
snyk,snyk --helpshould both displayhelp.txtAny background context you want to provide?
It's just an improvement, making it a little bit more user friendly.
What are the relevant tickets?
None. Encountered this on first usage, and wanted to fix it directly. Let me know if you need a github issue.
Screenshots
before
after
Additional questions
None