github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-07 12:11:43 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #26977 from joe2far/fix-help-strings

Browse Source 
Automatic merge from submit-queue

Make kubectl help strings consistent
This commit is contained in:
k8s-merge-robot
2016-07-07 00:12:22 -07:00
committed by GitHub
parent 8741217179 25b4341dc7
commit 2da247ffbc
26 changed files with 50 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/devel/kubectl-conventions.md
View File

@@ -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 `$`