Use markdown in CLI examples for automatic documentation generation

docker / app

Make your Docker Compose applications reusable, and share them on Docker Hub

Apache License 2.0

1.57k stars 176 forks source link

Use markdown in CLI examples for automatic documentation generation #737

Closed jcsirot closed 4 years ago

jcsirot commented 4 years ago

- What I did This PR updates the examples in CLI help in order to use markdown syntax

- How to verify it use the --help flag to see the examples

- A picture of a cute animal (not mandatory) me having an existential crisis in the shower when i should’ve gotten out 35 minutes ago

carolinebriaud commented 4 years ago

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)

jcsirot commented 4 years ago

@carolinebriaud good catch