summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Rubin <mrubin@google.com>2016-05-24 16:36:17 -0700
committerMichael Rubin <mrubin@google.com>2016-06-26 22:51:16 -0700
commitb601f18a298d833b76c7ba0d1e47c24ff4e02dc8 (patch)
treecb4cebe197e2c89685f3b4d055a282fcee22ffce
parent53d6a995ab15e458856a53cd18fa617b2e4ccc05 (diff)
Document usage of dedent for kubectl commands
-rw-r--r--kubectl-conventions.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/kubectl-conventions.md b/kubectl-conventions.md
index 4d11fc02..0beb95a7 100644
--- a/kubectl-conventions.md
+++ b/kubectl-conventions.md
@@ -279,15 +279,17 @@ type MineConfig struct {
mineLatest bool
}
-const (
- mineLong = `Some long description
-for my command.`
+var (
+ mineLong = dedent.Dedent(`
+ mine which is described here
+ with lots of details.`)
- mineExample = ` # Run my command's first action
- $ %[1]s first
+ mineExample = dedent.Dedent(`
+ # Run my command's first action
+ kubectl mine first_action
- # Run my command's second action on latest stuff
- $ %[1]s second --latest`
+ # Run my command's second action on latest stuff
+ kubectl mine second_action --flag`)
)
// NewCmdMine implements the kubectl mine command.