clean up

Author: madsbk

zarr/util.py

@@ -20,9 +20,9 @@
 
 
 # TODO: move the function to numcodecs
-def ensure_ndarray(buf, allow_copy=False, like=np.empty(())):
-    """Convenience function to coerce `buf` to numpy array like, if it is not already
-    numpy array like.
+def ensure_ndarray(buf):
+    """Convenience function to coerce `buf` to a numpy array-like, if it is not
+    already a numpy array-like.
 
     Parameters
     ----------
@@ -31,12 +31,13 @@ def ensure_ndarray(buf, allow_copy=False, like=np.empty(())):
 
     Returns
     -------
-    arr : ndarray-like
+    arr : array-like
         A numpy array-like, sharing memory with `buf`.
 
     Notes
     -----
-    This function will not create a copy under any circumstances if `allow_copy=False`.
+    This function will not create a copy under any circumstances, it is guaranteed to
+    return a view on memory exported by `buf`.
     """
 
     if isinstance(buf, np.ndarray):