diff options
Diffstat (limited to 'style.md')
-rw-r--r-- | style.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/style.md b/style.md new file mode 100644 index 0000000..83410e2 --- /dev/null +++ b/style.md @@ -0,0 +1,30 @@ +# Spelling + +All documentation is written in U.S. English + +# Grammar + +## Comma And + +**In lists**, the last element is mentioned using the word 'and', *without* a +comma. + +**When joining independent clauses**, keep a comma before the word 'and'. +Usually, this comma can be left out for short clauses, but we keep them in for +consistency. + +**Good examples:** + +> The first, second and last items. +> +> Action X was performed, and this had Y impact. + +# Figures + +Non-raster figures are preferred over rasterized figures (where applicable). +Please note that LaTeX does not support SVG images, and these need to be +converted to PDF (e.g. using `svg2pdf` on linux). + +Raster images should only be used when the source is already in a raster format +(e.g. for photos) or when otherwise impractical. + |