From baef1f2291abfcdaedec12d7b5afa230fe1d3db5 Mon Sep 17 00:00:00 2001 From: gfyoung Date: Thu, 27 Oct 2016 14:20:29 -0400 Subject: [PATCH] DOC: Patch doc errors for atleast_nd and frombuffer Closes gh-8214. Closes gh-8215. --- numpy/add_newdocs.py | 2 +- numpy/core/shape_base.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index e3304d191a86..8a24bead1f8a 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -1126,7 +1126,7 @@ def luf(lamdaexpr, *args, **kwargs): count : int, optional Number of items to read. ``-1`` means all data in the buffer. offset : int, optional - Start reading the buffer from this offset; default: 0. + Start reading the buffer from this offset (in bytes); default: 0. Notes ----- diff --git a/numpy/core/shape_base.py b/numpy/core/shape_base.py index 2b5110473bcb..70afdb7465ec 100644 --- a/numpy/core/shape_base.py +++ b/numpy/core/shape_base.py @@ -21,7 +21,7 @@ def atleast_1d(*arys): Returns ------- ret : ndarray - An array, or sequence of arrays, each with ``a.ndim >= 1``. + An array, or list of arrays, each with ``a.ndim >= 1``. Copies are made only if necessary. See Also @@ -72,7 +72,7 @@ def atleast_2d(*arys): Returns ------- res, res2, ... : ndarray - An array, or tuple of arrays, each with ``a.ndim >= 2``. + An array, or list of arrays, each with ``a.ndim >= 2``. Copies are avoided where possible, and views with two or more dimensions are returned. @@ -124,7 +124,7 @@ def atleast_3d(*arys): Returns ------- res1, res2, ... : ndarray - An array, or tuple of arrays, each with ``a.ndim >= 3``. Copies are + An array, or list of arrays, each with ``a.ndim >= 3``. Copies are avoided where possible, and views with three or more dimensions are returned. For example, a 1-D array of shape ``(N,)`` becomes a view of shape ``(1, N, 1)``, and a 2-D array of shape ``(M, N)`` becomes a