diff options
author | Eric Wieser <wieser.eric@gmail.com> | 2019-02-24 18:34:59 -0800 |
---|---|---|
committer | Eric Wieser <wieser.eric@gmail.com> | 2019-02-24 21:02:50 -0800 |
commit | ed4f296fca51e6672c23f51199a8bfc222853497 (patch) | |
tree | 2db410f8eb4ff87cca1d520ba12949962b0de8bf | |
parent | 4df5bfd07a5de775c4d6ada5ba267ab3930175bf (diff) | |
download | numpy-ed4f296fca51e6672c23f51199a8bfc222853497.tar.gz |
DOC: Remove incorrect statement about `randn` accepting floats as sizes
This gives an error at least as far back as 1.12.x
-rw-r--r-- | numpy/random/mtrand/mtrand.pyx | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/numpy/random/mtrand/mtrand.pyx b/numpy/random/mtrand/mtrand.pyx index ca9840055..890e85e54 100644 --- a/numpy/random/mtrand/mtrand.pyx +++ b/numpy/random/mtrand/mtrand.pyx @@ -1372,13 +1372,11 @@ cdef class RandomState: Return a sample (or samples) from the "standard normal" distribution. - If positive, int_like or int-convertible arguments are provided, - `randn` generates an array of shape ``(d0, d1, ..., dn)``, filled + If positive int_like arguments are provided, `randn` generates an array + of shape ``(d0, d1, ..., dn)``, filled with random floats sampled from a univariate "normal" (Gaussian) - distribution of mean 0 and variance 1 (if any of the :math:`d_i` are - floats, they are first converted to integers by truncation). A single - float randomly sampled from the distribution is returned if no - argument is provided. + distribution of mean 0 and variance 1. A single float randomly sampled + from the distribution is returned if no argument is provided. This is a convenience function. If you want an interface that takes a tuple as the first argument, use `numpy.random.standard_normal` instead. |