From 5c6d9f4ad94fa5ea5eb4d422226fb47b733740de Mon Sep 17 00:00:00 2001 From: annainfo Date: Sun, 19 Aug 2018 10:02:35 +0200 Subject: [PATCH] Update style-guide.md (#28754) 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 a288a2dae4193c245205b05055869d115b08bdba) --- doc/src/manual/style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/manual/style-guide.md b/doc/src/manual/style-guide.md index 624297d8a10fa..a39697d124456 100644 --- a/doc/src/manual/style-guide.md +++ b/doc/src/manual/style-guide.md @@ -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 @@ -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: