diff options
| author | rgommers <ralf.gommers@googlemail.com> | 2011-03-02 12:55:04 +0800 |
|---|---|---|
| committer | rgommers <ralf.gommers@googlemail.com> | 2011-03-02 13:23:49 +0800 |
| commit | 68e33f93d49d39cfd3789d85224a65036f03ee11 (patch) | |
| tree | 67f413c015e877fe2fcbe13d7df451c28cc481fc /numpy/core/shape_base.py | |
| parent | 4ca2465fe169576b46dee783dd0279cfd536d9c4 (diff) | |
| download | numpy-68e33f93d49d39cfd3789d85224a65036f03ee11.tar.gz | |
DOC: merge wiki edits for numpy.core.
Diffstat (limited to 'numpy/core/shape_base.py')
| -rw-r--r-- | numpy/core/shape_base.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/numpy/core/shape_base.py b/numpy/core/shape_base.py index 4c84cf397..15f188792 100644 --- a/numpy/core/shape_base.py +++ b/numpy/core/shape_base.py @@ -102,18 +102,18 @@ def atleast_3d(*arys): Parameters ---------- array1, array2, ... : array_like - One or more array-like sequences. Non-array inputs are converted - to arrays. Arrays that already have three or more dimensions are + One or more array-like sequences. Non-array inputs are converted to + arrays. Arrays that already have three or more dimensions are preserved. Returns ------- res1, res2, ... : ndarray - An array, or tuple 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)``. A 2-D array of shape ``(M, N)`` - becomes a view of shape ``(M, N, 1)``. + An array, or tuple 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 + view of shape ``(M, N, 1)``. See Also -------- |