docs: type the demo commands with long flag names - #489
Open
utkuozdemir wants to merge 1 commit into
Open
Conversation
The two README recordings typed their commands with shorthand flags. The short names say nothing to someone who sees the tool for the first time, and that is who watches the recordings. Both tapes now type the long flag names, spread over continuation lines with one group of flags per line, so the command reads as it would in the docs. The recording is taller, so that the typed command and the whole run stay on one screen in the success recording. The recordings are made again from the current output, so they show the narrated text output as well. Closes #481. Signed-off-by: Utku Ozdemir <utkuozdemir@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #489 +/- ##
==========================================
- Coverage 82.35% 82.33% -0.03%
==========================================
Files 53 53
Lines 3877 3877
==========================================
- Hits 3193 3192 -1
- Misses 684 685 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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.
The two README recordings typed their commands with shorthand flags. The short names say nothing to someone who sees the tool for the first time, and that is who watches the recordings.
Both tapes now type the long flag names, spread over continuation lines with one group of flags per line, so the command reads as it would in the docs. The recording is taller, so that the typed command and the whole run stay on one screen in the success recording.
The recordings are made again from the current output, so they show the narrated text output as well.
Closes #481.