Improve --help output
#1078
Merged
Improve --help output
#1078
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
This replaces the `main()` function docstring which was confusing for end users and also not well formatted.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1078 +/- ##
=======================================
Coverage 84.45% 84.45%
=======================================
Files 26 26
Lines 1396 1396
=======================================
Hits 1179 1179
Misses 217 217 ☔ View full report in Codecov by Sentry. |
|
Will merge after #1077 |
|
Thanks a lot for this! Feel free to join our dev meetings at 19:00 CET on our discord :) |
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.
Fixes #1072
main()docstring in--helpoutput with a more descriptive description of the application--clarifyand--self-healoption descriptions (from @hmasdev in Fix CLI help message #1024)--improve,--clarifyand--self-healhelp text formats (from @hmasdev in Fix CLI help message #1024)