The coding style in this package tries to stick to Blue.
Naming
- UpperCamelCase for modules and type names
- lower_snake_case for method names
- Interpretable names (without abbreviation) & without being verbose
- No method names that are clear from type
Spacing
- 4 spaces per indentation level, no tabs
- whitespace for readability
- no trailing whitespace
- 92 character line length limit
- No padding brackets with spaces
Comments
- necessary comments to explain code
- "Julia" = language; "julia" = executable
Functions
- Include explicit
returns - functions mutating at least one of their arguments end in
!
Custom styles
- Import modules with
using, with one module per line and at the top of the file - Never say 'error'!