Skip to content

Commit

Permalink
Update style_guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 committed Sep 20, 2024
1 parent 47f865e commit 252fe3a
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions helpers/style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,16 @@
- Use one line per sentence during development for ease of tracking changes
- Leave a single empty line space before and after each code chunk
- Format content as follows:
- **package_name**
- **PackageName.jl**
- `class_of_object`
- `function_name()`
- Spelling: use `en-us`
- Use of `\index{}` is recommended

# Code

- `library(package)` - library without quotes
- `=` - assignment operator (instead of `<-`)
- ` = ` , ` > `, etc. - spaces around operators
- `"text"` - double quotes for character values
- `for (i in 1:9) {print(i)}` - use space separation for curly brackets. Also use space after `for`.
- When indenting your code, use two spaces
- When indenting your code, use two spaces [TODO: should we use four spaces?]

# Comments

Expand Down Expand Up @@ -46,4 +42,4 @@ Names of the figures should contain a chapter number, e.g. `04-world-map.png` or
# File names

- Minimize capitalization: use `file-name.rds` not `file-name.Rds`
- `-` not `_`: use `file-name.rds` not `file_name.rds`
- `-` not `_`: use `file-name.rds` not `file_name.rds`

0 comments on commit 252fe3a

Please sign in to comment.