diff options
| author | joe2far <joe2farrell@gmail.com> | 2016-06-07 18:38:04 +0100 |
|---|---|---|
| committer | joe2far <joe2farrell@gmail.com> | 2016-06-29 12:50:24 +0100 |
| commit | 91f816494452b3a9a4e39117bdadb7b64279c8e2 (patch) | |
| tree | 55355eb3aea0951233c2fc2af0829b4c5fc2ca51 | |
| parent | 8e1eb3f04593cd164f67a01846c4d1309db0819d (diff) | |
Make kubectl help strings consistent
| -rw-r--r-- | kubectl-conventions.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/kubectl-conventions.md b/kubectl-conventions.md index 0beb95a7..40cb7e59 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 `$` |