summaryrefslogtreecommitdiff
path: root/numpy/lib/function_base.py
diff options
context:
space:
mode:
authorBrandon Carter <bcarter@mit.edu>2016-12-19 13:47:17 -0500
committerBrandon Carter <bcarter@mit.edu>2016-12-19 13:47:17 -0500
commit8fb4d0c4b687b514416c280c5c738469e67854b2 (patch)
treecaaa76e30c7d02d1197ce4eedc41d82a2945029e /numpy/lib/function_base.py
parenta35f997dd6e50560391519c71c814f1175ea8c71 (diff)
downloadnumpy-8fb4d0c4b687b514416c280c5c738469e67854b2.tar.gz
change rowvar param to boolean from int in corrcoef
Diffstat (limited to 'numpy/lib/function_base.py')
-rw-r--r--numpy/lib/function_base.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py
index 172e9a322..b7160fe05 100644
--- a/numpy/lib/function_base.py
+++ b/numpy/lib/function_base.py
@@ -2918,7 +2918,7 @@ def cov(m, y=None, rowvar=True, bias=False, ddof=None, fweights=None,
return c.squeeze()
-def corrcoef(x, y=None, rowvar=1, bias=np._NoValue, ddof=np._NoValue):
+def corrcoef(x, y=None, rowvar=True, bias=np._NoValue, ddof=np._NoValue):
"""
Return Pearson product-moment correlation coefficients.
@@ -2939,8 +2939,8 @@ def corrcoef(x, y=None, rowvar=1, bias=np._NoValue, ddof=np._NoValue):
y : array_like, optional
An additional set of variables and observations. `y` has the same
shape as `x`.
- rowvar : int, optional
- If `rowvar` is non-zero (default), then each row represents a
+ rowvar : bool, optional
+ If `rowvar` is True (default), then each row represents a
variable, with observations in the columns. Otherwise, the relationship
is transposed: each column represents a variable, while the rows
contain observations.