diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2017-09-29 09:44:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-29 09:44:15 -0700 |
| commit | 258f79770304a9b1f46c54ec19e57bb73d3ff2b6 (patch) | |
| tree | 47092e3bb8cb4b4632240cf09691b214fab14a31 | |
| parent | c4d900e55bf67ba87eb7e4c368a8486ff4ca3761 (diff) | |
| parent | 34b87577724a56989a939fe43327ec8af2b9c37c (diff) | |
Merge pull request #929 from tcharding/kubectl-conventions
Automatic merge from submit-queue.
Update Example conventions
**Why this PR is needed**
Currently `kubectl-conventions.md` contains incorrect conventions for command examples. File currently stipulates that example commands should start with a `$`, this is incorrect.
Currently conventions stipulate that command example comments should terminate with a period. This is overly restrictive and trivial. Conventions would be better if this was relaxed to allow developer discretion.
**What this PR does**
Remove `$` convention and stipulate explicitly that command examples **do not** start with a `$`. Remove convention stipulating command examples terminate with a period.
| -rw-r--r-- | contributors/devel/kubectl-conventions.md | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/contributors/devel/kubectl-conventions.md b/contributors/devel/kubectl-conventions.md index 90a77633..6b495718 100644 --- a/contributors/devel/kubectl-conventions.md +++ b/contributors/devel/kubectl-conventions.md @@ -256,10 +256,8 @@ 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 `$` - - + an uppercase letter + * Command examples should not include a `$` prefix * Use "FILENAME" for filenames |