generate

Documentation

Index

• func DocForCommand(command *cobra.Command) (string, error)
• func Docs(root *cobra.Command, path string, testPath string, codePath string) error
• func ErrorCodes(docPath string, pathsToCheck []string) error
• func GenMarkdown(cmd *cobra.Command, w io.Writer) error
• func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
• func TestDocs(docPath string, pathToCheck string) error
• type TestDoc

Functions

func DocForCommand

func DocForCommand(command *cobra.Command) (string, error)

DocForCommand returns the specific doc for that command

func Docs

func Docs(root *cobra.Command, path string, testPath string, codePath string) error

Docs generates docs for minikube command

func ErrorCodes

func ErrorCodes(docPath string, pathsToCheck []string) error

func GenMarkdown

func GenMarkdown(cmd *cobra.Command, w io.Writer) error

GenMarkdown creates markdown output.

func GenMarkdownCustom

func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenMarkdownCustom creates custom markdown output.

func TestDocs

func TestDocs(docPath string, pathToCheck string) error

Types

type TestDoc

type TestDoc struct {
	// contains filtered or unexported fields
}

TestDoc is the documentation for a test case