Add function godocs

This commit is contained in:
Justin Santa Barbara 2017-07-15 12:59:17 -04:00
parent 7a870f65b9
commit e0acbc37a7
1 changed files with 3 additions and 0 deletions

View File

@ -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)