Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rand! and randn! to docstrings of rand and randn #49808

Merged
merged 6 commits into from
May 24, 2023
Merged

Add rand! and randn! to docstrings of rand and randn #49808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de58edd
add randn! to randn's docstring
Vilin97 May 13, 2023
d17456c
add rand! to rand's docstring
Vilin97 May 13, 2023
ff5a61b
add @ref
Vilin97 May 14, 2023
ffba3d3
add @ref to docstring
Vilin97 May 14, 2023
5c696ea
fix typo
Vilin97 May 14, 2023
51ed17e
also add `randn` to the docstring
Vilin97 May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions stdlib/Random/src/Random.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@ When only one argument is passed besides the optional `rng` and is a `Tuple`, it
as a collection of values (`S`) and not as `dims`.


See also [`randn`](@ref) for normally distributed numbers, and [`rand!`](@ref) and [`randn!`](@ref) for the in-place equivalents.

!!! compat "Julia 1.1"
Support for `S` as a tuple requires at least Julia 1.1.

Expand Down
2 changes: 2 additions & 0 deletions stdlib/Random/src/normal.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ The `Base` module currently provides an implementation for the types
[`Complex`](@ref) counterparts. When the type argument is complex, the values are drawn
from the circularly symmetric complex normal distribution of variance 1 (corresponding to real and imaginary part having independent normal distribution with mean zero and variance `1/2`).

See also [`randn!`](@ref) to act in-place.

# Examples
```jldoctest
julia> using Random
Expand Down