Skip to content

Commit

Permalink
Merge pull request kubernetes#929 from tcharding/kubectl-conventions
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Kubernetes Submit Queue authored Sep 29, 2017
2 parents c4d900e + 34b8757 commit 258f797
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions contributors/devel/kubectl-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 258f797

Please sign in to comment.