fix: make command usage more readable in doc #549
Merged
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
Signed-off-by: Allen Sun <[email protected]>
allencloud
force-pushed
the
command-readable
branch
from
6bb21f0 to
92c94a9
Compare
allencloud
commented
Jan 10, 2018
| @@ -48,7 +48,7 @@ func (suite *PouchStopSuite) TestStopWorks(c *check.C) { | |||
|
|
|||
| // test stop container with timeout(*seconds) | |||
| command.PouchRun("start", name).Assert(c, icmd.Success) | |||
| command.PouchRun("stop", name, "3").Assert(c, icmd.Success) | |||
| command.PouchRun("stop", "-t", "3", name).Assert(c, icmd.Success) | |||
There was a problem hiding this comment.
This pr helped me to find a tiny mistake in the test case. Just comment to record this.
Codecov Report
@@ Coverage Diff @@
## master #549 +/- ##
=======================================
Coverage 20.47% 20.47%
=======================================
Files 39 39
Lines 2056 2056
=======================================
Hits 421 421
Misses 1590 1590
Partials 45 45Continue to review full report at Codecov.
|
|
LGTM |
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.
Signed-off-by: Allen Sun [email protected]
1.Describe what this PR did
Issue #541 mentioned that in pouch's cli command usage was not so readable. Originally, there are always a
[flags]at the postfix of the usage sentence, like:With this PR, we add a
childCmd.DisableFlagsInUseLine = trueto the command to disable flags in useline. With this, usage shows like:2.Does this pull request fix one issue?
fixes #541
3.Describe how you did it
childCmd.DisableFlagsInUseLine = true4.Describe how to verify it
5.Special notes for reviews
NONE