Show help examples

ammario · ammario · commit 1c3ee92039c4 · 2019-04-26T16:29:33.000-05:00
diff --git a/README.md b/README.md
@@ -61,6 +61,16 @@ func main() {
 }
 
 ```
+renders a help like
+
+```
+Usage: simple-example [flags]
+
+This is a simple example of the cli package.
+
+simple-example flags:
+	-v	sets verbose mode	(false)
+```
 
 ### Subcommands
 
@@ -114,4 +124,15 @@ func (c *cmd) Subcommands() []cli.Command {
 func main() {
     cli.RunRoot(&cmd{})
 }
+```
+
+renders a help like
+
+```
+Usage: subcommand [flags]
+
+This is a simple example of subcommands.
+
+Commands:
+	sub	This is a simple subcommand.
 ```
diff --git a/help.go b/help.go
@@ -18,7 +18,7 @@ func renderFlagHelp(fl *flag.FlagSet, w io.Writer) {
 	var count int
 	fl.VisitAll(func(f *flag.Flag) {
 		if count == 0 {
-			fmt.Fprintf(w, "%v flags:\n", fl.Name())
+			fmt.Fprintf(w, "\n%v flags:\n", fl.Name())
 		}
 
 		count++

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ func renderFlagHelp(fl *flag.FlagSet, w io.Writer) {`
`18`	`18`	`var count int`
`19`	`19`	`fl.VisitAll(func(f *flag.Flag) {`
`20`	`20`	`if count == 0 {`
`21`		`- fmt.Fprintf(w, "%v flags:\n", fl.Name())`
	`21`	`+ fmt.Fprintf(w, "\n%v flags:\n", fl.Name())`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`count++`