Skip to content

Commit

Permalink
Update style-guide.md (#28754)
Browse files Browse the repository at this point in the history
s/Julia's Base/Julia Base - as elsewhere, e.g. Julia Base (notably in intro of https://github.com/JuliaLang/julia/commits/master/doc/src/base/base.md), Julia functions, Julia variables, Julia Function Pointers, Julia startup, Julia runtime

(cherry picked from commit a288a2d)
  • Loading branch information
annainfo authored and KristofferC committed Aug 19, 2018
1 parent 07df284 commit d7edc36
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/src/manual/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ a = Vector{Union{Int,AbstractString,Tuple,Array}}(undef, n)
In this case `Vector{Any}(undef, n)` is better. It is also more helpful to the compiler to annotate specific
uses (e.g. `a[i]::Int`) than to try to pack many alternatives into one type.

## Use naming conventions consistent with Julia's `base/`
## Use naming conventions consistent with Julia `base/`

* modules and type names use capitalization and camel case: `module SparseArrays`, `struct UnitRange`.
* functions are lowercase ([`maximum`](@ref), [`convert`](@ref)) and, when readable, with multiple
Expand All @@ -143,7 +143,7 @@ uses (e.g. `a[i]::Int`) than to try to pack many alternatives into one type.
If a function name requires multiple words, consider whether it might represent more than one
concept and might be better split into pieces.

## Write functions with argument ordering similar to Julia's Base
## Write functions with argument ordering similar to Julia Base

As a general rule, the Base library uses the following order of arguments to functions,
as applicable:
Expand Down

0 comments on commit d7edc36

Please sign in to comment.