summaryrefslogtreecommitdiff
path: root/numpy/core/numeric.py
diff options
context:
space:
mode:
authorjeremycl01 <jlay80@gmail.com>2019-05-25 16:58:14 -0500
committerGitHub <noreply@github.com>2019-05-25 16:58:14 -0500
commitbe9a134202e097d7d279425bdb137409084fe115 (patch)
tree492879f47c2ff0efaea3a8eb8c7942bdda3fae76 /numpy/core/numeric.py
parentcf704e7f245e89c623bd82cbdba7c2dd07cf5fb4 (diff)
downloadnumpy-be9a134202e097d7d279425bdb137409084fe115.tar.gz
DOC: update isfortran docs with return value
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r--numpy/core/numeric.py11
1 files changed, 8 insertions, 3 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index 55e6c1cad..3c64f9aa1 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -472,17 +472,22 @@ def count_nonzero(a, axis=None):
@set_module('numpy')
def isfortran(a):
"""
- Returns True if the array is Fortran contiguous but *not* C contiguous.
-
+ Check if the array is Fortran contiguous but *not* C contiguous.
+
This function is obsolete and, because of changes due to relaxed stride
checking, its return value for the same array may differ for versions
of NumPy >= 1.10.0 and previous versions. If you only want to check if an
array is Fortran contiguous use ``a.flags.f_contiguous`` instead.
-
+
Parameters
----------
a : ndarray
Input array.
+
+ Returns
+ -------
+ isfortran : bool
+ Returns True if the array is Fortran contiguous but *not* C contiguous.
Examples