docs: disambiguate what rand((2, 3)) does (fix #33309) (#33742)

* docs: disambiguate what rand((2, 3)) does (fix #33309) * Update stdlib/Random/src/Random.jl Co-Authored-By: Matt Bauman <[email protected]>
JuliaLang · Apr 11, 2020 · 95169b4 · 95169b4
1 parent feb544c
commit 95169b4
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/stdlib/Random/src/Random.jl b/stdlib/Random/src/Random.jl
@@ -315,6 +315,9 @@ Pick a random element or array of random elements from the set of values specifi
   point numbers and to ``[0, 1)+i[0, 1)]`` for complex floating point numbers;
 
 `S` defaults to [`Float64`](@ref).
+When only one argument is passed besides the optional `rng` and is a `Tuple`, it is interpreted
+as a collection of values (`S`) and not as `dims`.
+
 
 !!! compat "Julia 1.1"
     Support for `S` as a tuple requires at least Julia 1.1.
@@ -330,6 +333,14 @@ julia> using Random
 
 julia> rand(MersenneTwister(0), Dict(1=>2, 3=>4))
 1=>2
+
+julia> rand((2, 3))
+3
+
+julia> rand(Float64, (2, 3))
+2×3 Array{Float64,2}:
+ 0.999717  0.0143835  0.540787
+ 0.696556  0.783855   0.938235
 ```
 
 !!! note