Add function godocs

kubernetes · Jul 15, 2017 · 7819b8a · 7819b8a
1 parent 8cede79
commit 7819b8a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pkg/pretty/help.go b/pkg/pretty/help.go
@@ -22,10 +22,13 @@ import (
 	"strings"
 )
 
+// Bash markdown-quotes a bash command for insertion into help text.
 func Bash(s string) string {
 	return fmt.Sprintf("`%s`", s)
 }
 
+// LongDesc is used for formatting help text for a commands Long Description.
+// It de-dents it and trims it.
 func LongDesc(s string) string {
 	s = heredoc.Doc(s)
 	s = strings.TrimSpace(s)