Skip to content

Commit

Permalink
Added note about $ in bash examples
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Apr 20, 2016
1 parent 6b9c341 commit 2349688
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs-styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This is the documentation styleguide for our natural language descriptions used

* Use `backticks` for every code example inside of a normal description. In the CLI, where you cannot use backticks, use 'single quotes' for commands.
* Default settings should always be specified in a new sentence, not in parentheses, at the end. Default: like this.
* For bash arguments, do not include a `$` before commands in man pages. A `$` may be included in READMEs.

### Acronyms

Expand Down

0 comments on commit 2349688

Please sign in to comment.