summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabiano Franz <ffranz@redhat.com>2016-10-10 19:07:07 -0300
committerFabiano Franz <ffranz@redhat.com>2016-10-17 11:50:02 -0200
commit04122e99c65fbd34b6cfbfd374160961324c62db (patch)
treebf005f378c31ce265c1ea77ce6000b9daad0b722
parent83de8a4818207824b3eb4b824235e924ece4734d (diff)
Use our own normalizers in the conventions doc
-rw-r--r--kubectl-conventions.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/kubectl-conventions.md b/kubectl-conventions.md
index fe2e51a1..dd388a61 100644
--- a/kubectl-conventions.md
+++ b/kubectl-conventions.md
@@ -301,24 +301,25 @@ Sample command skeleton:
// MineRecommendedName is the recommended command name for kubectl mine.
const MineRecommendedName = "mine"
-// MineConfig contains all the options for running the mine cli command.
-type MineConfig struct {
- mineLatest bool
-}
-
+// Long command description and examples.
var (
- mineLong = dedent.Dedent(`
- mine which is described here
- with lots of details.`)
+ mineLong = templates.LongDesc(`
+ mine which is described here
+ with lots of details.`)
- mineExample = dedent.Dedent(`
- # Run my command's first action
- kubectl mine first_action
+ mineExample = templates.Examples(`
+ # Run my command's first action
+ kubectl mine first_action
- # Run my command's second action on latest stuff
- kubectl mine second_action --flag`)
+ # Run my command's second action on latest stuff
+ kubectl mine second_action --flag`)
)
+// MineConfig contains all the options for running the mine cli command.
+type MineConfig struct {
+ mineLatest bool
+}
+
// NewCmdMine implements the kubectl mine command.
func NewCmdMine(parent, name string, f *cmdutil.Factory, out io.Writer) *cobra.Command {
opts := &MineConfig{}