mirror of
https://github.com/spf13/cobra
synced 2024-06-26 05:39:09 +00:00
b3f29e98e6
* Move man_docs and md_docs into new doc pkg * Replace *bytes.Buffer with io.Writer * Replace c == cmd.helpCommand with c.IsHelpCommand() * Remove redundant len(children) == 0 check in HasSeeAlso * Duplicate test setup for doc generation
36 lines
572 B
Go
36 lines
572 B
Go
package doc_test
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/cobra/doc"
|
|
)
|
|
|
|
func ExampleCommand_GenManTree() {
|
|
cmd := &cobra.Command{
|
|
Use: "test",
|
|
Short: "my test program",
|
|
}
|
|
header := &doc.GenManHeader{
|
|
Title: "MINE",
|
|
Section: "3",
|
|
}
|
|
doc.GenManTree(cmd, header, "/tmp")
|
|
}
|
|
|
|
func ExampleCommand_GenMan() {
|
|
cmd := &cobra.Command{
|
|
Use: "test",
|
|
Short: "my test program",
|
|
}
|
|
header := &doc.GenManHeader{
|
|
Title: "MINE",
|
|
Section: "3",
|
|
}
|
|
out := new(bytes.Buffer)
|
|
doc.GenMan(cmd, header, out)
|
|
fmt.Print(out.String())
|
|
}
|