Merge pull request #12302 from teoliphant/update-asfortranarray-docstring

DOC: Update the docstring of asfortranarray and ascontiguousarray

1 files changed, 8 insertions, 2 deletions

diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index 5d82bbd8d..265c3636f 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -587,7 +587,7 @@ def asanyarray(a, dtype=None, order=None):
 
 def ascontiguousarray(a, dtype=None):
     """
-    Return a contiguous array in memory (C order).
+    Return a contiguous array (ndim >= 1) in memory (C order).
 
     Parameters
     ----------
@@ -618,13 +618,16 @@ def ascontiguousarray(a, dtype=None):
     >>> x.flags['C_CONTIGUOUS']
     True
 
+    Note: This function returns an array with at least one-dimension (1-d) 
+    so it will not preserve 0-d arrays.  
+
     """
     return array(a, dtype, copy=False, order='C', ndmin=1)
 
 
 def asfortranarray(a, dtype=None):
     """
-    Return an array laid out in Fortran order in memory.
+    Return an array (ndim >= 1) laid out in Fortran order in memory.
 
     Parameters
     ----------
@@ -655,6 +658,9 @@ def asfortranarray(a, dtype=None):
     >>> y.flags['F_CONTIGUOUS']
     True
 
+    Note: This function returns an array with at least one-dimension (1-d) 
+    so it will not preserve 0-d arrays.  
+
     """
     return array(a, dtype, copy=False, order='F', ndmin=1)