From 91f816494452b3a9a4e39117bdadb7b64279c8e2 Mon Sep 17 00:00:00 2001 From: joe2far Date: Tue, 7 Jun 2016 18:38:04 +0100 Subject: [PATCH] Make kubectl help strings consistent --- kubectl-conventions.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/kubectl-conventions.md b/kubectl-conventions.md index 0beb95a7c..40cb7e59f 100644 --- a/kubectl-conventions.md +++ b/kubectl-conventions.md @@ -125,6 +125,9 @@ flags and separate help that is tailored for the particular usage. * Flag names and single-character aliases should have the same meaning across all commands +* Flag descriptions should start with an uppercase letter and not have a +period at the end of a sentence + * Command-line flags corresponding to API fields should accept API enums exactly (e.g., `--restart=Always`) @@ -233,9 +236,16 @@ resources in other commands an exhaustive specification * Short should contain a one-line explanation of what the command does + * Short descriptions should start with an uppercase case letter and not + have a period at the end of a sentence + * Short descriptions should (if possible) start with a first person + (singular present tense) verb * Long may contain multiple lines, including additional information about input, output, commonly used flags, etc. + * Long descriptions should use proper grammar, start with an uppercase + letter and have a period at the end of a sentence + * Example should contain examples * Start commands with `$`