summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/spf13/cobra/doc/man_examples_test.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/spf13/cobra/doc/man_examples_test.go')
-rw-r--r--vendor/github.com/spf13/cobra/doc/man_examples_test.go35
1 files changed, 35 insertions, 0 deletions
diff --git a/vendor/github.com/spf13/cobra/doc/man_examples_test.go b/vendor/github.com/spf13/cobra/doc/man_examples_test.go
new file mode 100644
index 000000000..3593853b0
--- /dev/null
+++ b/vendor/github.com/spf13/cobra/doc/man_examples_test.go
@@ -0,0 +1,35 @@
+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())
+}