This repository has been archived by the owner on Jun 13, 2021. It is now read-only.
Use markdown in CLI examples for automatic documentation generation #737
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
jcsirot
requested review from
carolinebriaud,
silvin-lubecki,
rumpl and
eunomie
|
LGTM. Maybe you could rename the example const to "buildexample" and "runexample" for build.go and run.go files (so it is consistent with other files, but it is minor) |
|
@carolinebriaud good catch |
Signed-off-by: Jean-Christophe Sirot <jean-christophe.sirot@docker.com>
jcsirot
force-pushed
the
markdown-cli-examples
branch
from
c46e425
to
8e29667
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 I did
This PR updates the examples in CLI help in order to use markdown syntax
- How to verify it
use the
--helpflag to see the examples- A picture of a cute animal (not mandatory)
