From e0acbc37a7937baa97d573c99dd2d19867a1b838 Mon Sep 17 00:00:00 2001 From: Justin Santa Barbara Date: Sat, 15 Jul 2017 12:59:17 -0400 Subject: [PATCH] Add function godocs --- pkg/pretty/help.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/pretty/help.go b/pkg/pretty/help.go index f83fd4c1c0..503c78ddd8 100644 --- 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)