diff options
author | Anthony Fok <foka@debian.org> | 2015-08-04 03:15:12 -0600 |
---|---|---|
committer | Anthony Fok <foka@debian.org> | 2015-08-04 03:19:57 -0600 |
commit | f2ab0b2608a1c4dc7109733be7eff80738ae9712 (patch) | |
tree | f7e62ec2544f4bf0b3417bc6aa5cdd967edc55cc /commands/convert.go | |
parent | e64e571b679b429f547b38ebcb1f8aab8d785e7b (diff) |
Improve formatting of Hugo command descriptions
Trying to make them look good both in the terminal (`hugo help [command]`)
and in the web browser (http://gohugo.io/commands/). :-)
Diffstat (limited to 'commands/convert.go')
-rw-r--r-- | commands/convert.go | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/commands/convert.go b/commands/convert.go index 6268fb2a2..188ab7a72 100644 --- a/commands/convert.go +++ b/commands/convert.go @@ -32,16 +32,18 @@ var unsafe bool var convertCmd = &cobra.Command{ Use: "convert", - Short: "Convert will modify your content to different formats", - Long: `Convert will modify your content to different formats`, + Short: "Convert your content to different formats", + Long: `Convert your content (e.g. front matter) to different formats. + +See convert's subcommands toJSON, toTOML and toYAML for more information.`, Run: nil, } var toJSONCmd = &cobra.Command{ Use: "toJSON", Short: "Convert front matter to JSON", - Long: `toJSON will convert all front matter in the content - directory to use JSON for the front matter`, + Long: `toJSON converts all front matter in the content directory +to use JSON for the front matter.`, Run: func(cmd *cobra.Command, args []string) { err := convertContents(rune([]byte(parser.JSON_LEAD)[0])) if err != nil { @@ -53,8 +55,8 @@ var toJSONCmd = &cobra.Command{ var toTOMLCmd = &cobra.Command{ Use: "toTOML", Short: "Convert front matter to TOML", - Long: `toTOML will convert all front matter in the content - directory to use TOML for the front matter`, + Long: `toTOML converts all front matter in the content directory +to use TOML for the front matter.`, Run: func(cmd *cobra.Command, args []string) { err := convertContents(rune([]byte(parser.TOML_LEAD)[0])) if err != nil { @@ -66,8 +68,8 @@ var toTOMLCmd = &cobra.Command{ var toYAMLCmd = &cobra.Command{ Use: "toYAML", Short: "Convert front matter to YAML", - Long: `toYAML will convert all front matter in the content - directory to use YAML for the front matter`, + Long: `toYAML converts all front matter in the content directory +to use YAML for the front matter.`, Run: func(cmd *cobra.Command, args []string) { err := convertContents(rune([]byte(parser.YAML_LEAD)[0])) if err != nil { |