Merge pull request #885 from tcharding/kubectl-conventions

Update Example conventions
2017-08-08 16:27:43 -03:00 · 2017-08-08 16:27:43 -03:00 · 181cbd1904
parent 85ddcc4af4 dc411e6ed8
commit 181cbd1904
1 changed files with 3 additions and 1 deletions
--- a/contributors/devel/kubectl-conventions.md
+++ b/contributors/devel/kubectl-conventions.md
@ -255,8 +255,10 @@ input, output, commonly used flags, etc.


  * Example should contain examples
+    * A comment should precede each example command. Comment should start with
+      an uppercase letter and terminate with a period
    * Start commands with `$`
-    * A comment should precede each example command, and should begin with `#`
+


 * Use "FILENAME" for filenames