document thread safety for RNGs (#40109)

JuliaLang · Mar 21, 2021 · 7d117dc · 7d117dc · nanosoldier · Mar 22, 2021
1 parent 6913f9c
commit 7d117dc
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/stdlib/Random/docs/src/index.md b/stdlib/Random/docs/src/index.md
@@ -13,7 +13,9 @@ type, which is a wrapper over the OS provided entropy.
 Most functions related to random generation accept an optional `AbstractRNG` object as first argument,
 which defaults to the global one if not provided. Moreover, some of them accept optionally
 dimension specifications `dims...` (which can be given as a tuple) to generate arrays of random
-values.
+values.  In a multi-threaded program, you should generally use different RNG objects from different threads
+in order to be thread-safe. However, the default global RNG is thread-safe as of Julia 1.3 (because
+it internally corresponds to a per-thread RNG).
 
 A `MersenneTwister` or `RandomDevice` RNG can generate uniformly random numbers of the following types:
 [`Float16`](@ref), [`Float32`](@ref), [`Float64`](@ref), [`BigFloat`](@ref), [`Bool`](@ref),