adphi/oh-my-zsh
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add syntax highlighting to code blocks

sunaku 2011-06-28 14:28:39 -07:00
parent 6d64481bb8
commit e5a7bbe845
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Coding-style-guide.md

@ -13,15 +13,19 @@ Variables name should not clobber command names, such as `dir`, `pwd`
Braces should be on the same line as the function name: Braces should be on the same line as the function name:
function helpful() { ```bash
... function helpful() {
} ...
}
```
Private or utility functions should be prefixed with an underscore: Private or utility functions should be prefixed with an underscore:
function _helper-util() { ```bash
... function _helper-util() {
} ...
}
```
## General ## General
@ -30,8 +34,10 @@ Indenting should be done with 2 spaces.
When possible, use environment variables instead of forking a command. When possible, use environment variables instead of forking a command.
$(pwd) # don't use, forks a new process ```bash
$PWD # do use $(pwd) # don't use, forks a new process
$PWD # do use
```
`if-then` statements should be on one line: `if-then` statements should be on one line: