Skip to content

Commit

Permalink
Merge pull request #18 from JuliaReach/mforets-patch-1
Browse files Browse the repository at this point in the history
Update guidelines.md
  • Loading branch information
mforets authored Sep 8, 2019
2 parents f846119 + da22ce6 commit bd52c88
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/src/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Depth = 3
"applied to a set of dimension $(dim(P))"
```

!!! note
The 80 characters rule should not be enforced in all cases, but is rather a soft guideline.

- Use the full `function f() ... end` instead of `f() = ...`. However, the short form is preferable in constructors and aliases such as `×(X::LazySet, Y::LazySet) = CartesianProduct(X, Y)`.

- Use the following conventions for type parameters:
Expand Down Expand Up @@ -353,3 +356,11 @@ This example has an optional argument with default value. Inside a `@docs` block
```julia
RecipesBase.apply_recipe(::Dict{Symbol,Any}, ::EmptySet{N}, ::N=zero(N)) where {N<:Real}
```

## Other style guides

Below we list other Julia code style guides that we have found interesting.

- [Yet Another Style Guide For Julia](https://github.com/jrevels/YASGuide)
- [JuMP.jl style guide](http://www.juliaopt.org/JuMP.jl/dev/style/#Style-guide-and-design-principles-1)
- [Julia style guide](https://docs.julialang.org/en/v1.2/manual/style-guide/#Style-Guide-1)

0 comments on commit bd52c88

Please sign in to comment.