Browse code

Update the cli hacking guide

Fabiano Franz authored on 2016/10/19 02:41:43
Showing 1 changed files
... ...
@@ -52,15 +52,17 @@ type MineOptions struct {
52 52
   mineLatest bool
53 53
 }
54 54
 
55
-const (
56
-  mineLong = `Some long description
57
-for my command.`
55
+var (
56
+  mineLong = templates.LongDesc(`
57
+    Some long description
58
+    for my command.`)
58 59
 
59
-  mineExample = `  # Run my command's first action
60
-  %[1]s first
60
+  mineExample = templates.Examples(`  
61
+    # Run my command's first action
62
+    %[1]s first
61 63
 
62
-  # Run my command's second action on latest stuff
63
-  %[1]s second --latest`
64
+    # Run my command's second action on latest stuff
65
+    %[1]s second --latest`)
64 66
 )
65 67
 
66 68
 // NewCmdMine implement the OpenShift cli mine command.
... ...
@@ -136,11 +138,12 @@ Example:
136 136
 ====
137 137
 [source,go,numbered,options="nowrap"]
138 138
 ----
139
-  deployExample = `  # Display the latest deployment for the 'database' deployment config
140
-  %[1]s database
139
+  deployExample = templates.Examples(`  
140
+    # Display the latest deployment for the 'database' deployment config
141
+    %[1]s database
141 142
 
142
-  # Start a new deployment based on the 'database' deployment config
143
-  %[1]s database --latest`
143
+    # Start a new deployment based on the 'database' deployment config
144
+    %[1]s database --latest`)
144 145
 ----
145 146
 ====
146 147
 
... ...
@@ -237,17 +240,19 @@ type DeployOptions struct {
237 237
   retryDeploy  bool
238 238
 }
239 239
 
240
-const (
240
+var (
241 241
   // 2.
242
-  deployLong = `Some long description 
243
-for the deploy command.` 
242
+  deployLong = templates.LongDesc(`
243
+    Some long description 
244
+    for the deploy command.`) 
244 245
 
245 246
   // 3.
246
-  deployExample = `  # Display the latest deployment for the 'database' DeploymentConfig
247
-  %[1]s database
247
+  deployExample = templates.Examples(`  
248
+    # Display the latest deployment for the 'database' DeploymentConfig
249
+    %[1]s database
248 250
 
249
-  # Start a new deployment based on the 'database' DeploymentConfig
250
-  %[1]s database --latest`
251
+    # Start a new deployment based on the 'database' DeploymentConfig
252
+    %[1]s database --latest`)
251 253
 )
252 254
 
253 255
 // 4.