Update Example conventions

This commit is contained in:
tcharding 2017-08-08 19:13:18 +10:00
parent ce1d55e3cb
commit dc411e6ed8
1 changed files with 3 additions and 1 deletions

View File

@ -255,8 +255,10 @@ 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 `$`
* A comment should precede each example command, and should begin with `#`
* Use "FILENAME" for filenames