From e2bb09430d90c73a7be6e47ea8c4528f094f693f Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Wed, 17 Feb 2010 23:53:04 +0000 Subject: more docstring updates from pydoc website (thanks to everyone who contributed!) --- numpy/lib/shape_base.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'numpy/lib/shape_base.py') diff --git a/numpy/lib/shape_base.py b/numpy/lib/shape_base.py index 69fe98314..ff187c63b 100644 --- a/numpy/lib/shape_base.py +++ b/numpy/lib/shape_base.py @@ -301,7 +301,7 @@ def dstack(tup): Stack arrays in sequence depth wise (along third axis). Takes a sequence of arrays and stack them along the third axis - to make a single array. Rebuilds arrays divided by ``dsplit``. + to make a single array. Rebuilds arrays divided by `dsplit`. This is a simple way to stack 2D arrays (images) into a single 3D array for processing. @@ -325,7 +325,7 @@ def dstack(tup): Notes ----- - Equivalent to ``np.concatenate(tup, axis=2)`` + Equivalent to ``np.concatenate(tup, axis=2)``. Examples -------- @@ -420,7 +420,7 @@ def split(ary,indices_or_sections,axis=0): If `indices_or_sections` is a 1-D array of sorted integers, the entries indicate where along `axis` the array is split. For example, - ``[2, 3]`` would, for ``axis = 0``, result in + ``[2, 3]`` would, for ``axis=0``, result in - ary[:2] - ary[2:3] @@ -483,8 +483,8 @@ def hsplit(ary,indices_or_sections): """ Split an array into multiple sub-arrays horizontally (column-wise). - Please refer to the ``split`` documentation. ``hsplit`` is equivalent - to ``split`` with `axis=1`, the array is always split along the second + Please refer to the `split` documentation. `hsplit` is equivalent + to `split` with ``axis=1``, the array is always split along the second axis regardless of the array dimension. See Also @@ -596,8 +596,8 @@ def dsplit(ary,indices_or_sections): """ Split array into multiple sub-arrays along the 3rd axis (depth). - Please refer to the ``split`` documentation. ``dsplit`` is equivalent - to ``split`` with `axis=2`, the array is always split along the third + Please refer to the `split` documentation. `dsplit` is equivalent + to `split` with ``axis=2``, the array is always split along the third axis provided the array dimension is greater than or equal to 3. See Also -- cgit v1.2.1