summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjessijzhao <35235453+jessijzhao@users.noreply.github.com>2021-10-27 10:35:31 -0700
committerGitHub <noreply@github.com>2021-10-27 10:35:31 -0700
commitf66a76ec2d592c4f44c3f44c596b6d6f581626e5 (patch)
tree2aa2b3172b0893559c77fc395b386b7eac13a1f7
parentba6cd71b14df1ea2694354ac9ce84e8f2d7aa65a (diff)
downloadnumpy-f66a76ec2d592c4f44c3f44c596b6d6f581626e5.tar.gz
DOC: Fix random.power Raises description (#20205)
Current documentation for random.power and random.Generator.power states that ValueError is raised if a < 1; however the power function distribution only supports strictly positive a > 0 and raises ValueError if a <= 0. Fixed documentation to reflect this.
-rw-r--r--numpy/random/_generator.pyx2
-rw-r--r--numpy/random/mtrand.pyx2
2 files changed, 2 insertions, 2 deletions
diff --git a/numpy/random/_generator.pyx b/numpy/random/_generator.pyx
index 54973100e..5347ea125 100644
--- a/numpy/random/_generator.pyx
+++ b/numpy/random/_generator.pyx
@@ -2097,7 +2097,7 @@ cdef class Generator:
Raises
------
ValueError
- If a < 1.
+ If a <= 0.
Notes
-----
diff --git a/numpy/random/mtrand.pyx b/numpy/random/mtrand.pyx
index ca539c00e..81a526ab4 100644
--- a/numpy/random/mtrand.pyx
+++ b/numpy/random/mtrand.pyx
@@ -2527,7 +2527,7 @@ cdef class RandomState:
Raises
------
ValueError
- If a < 1.
+ If a <= 0.
See Also
--------