Merge pull request #7253 from aukejw/stack_documentation_#7183

charris · charris · commit f4cc58c80df5 · 2016-02-16T11:13:07.000-07:00
DOC: note in h/v/dstack points users to stack/concatenate
diff --git a/numpy/core/shape_base.py b/numpy/core/shape_base.py
@@ -184,6 +184,10 @@ def vstack(tup):
     Take a sequence of arrays and stack them vertically to make a single
     array. Rebuild arrays divided by `vsplit`.
 
+    This function continues to be supported for backward compatibility, but
+    you should prefer ``np.concatenate`` or ``np.stack``. The ``np.stack``
+    function was added in NumPy 1.10.
+
     Parameters
     ----------
     tup : sequence of ndarrays
@@ -236,6 +240,10 @@ def hstack(tup):
     Take a sequence of arrays and stack them horizontally to make
     a single array. Rebuild arrays divided by `hsplit`.
 
+    This function continues to be supported for backward compatibility, but
+    you should prefer ``np.concatenate`` or ``np.stack``. The ``np.stack``
+    function was added in NumPy 1.10.
+
     Parameters
     ----------
     tup : sequence of ndarrays
diff --git a/numpy/lib/shape_base.py b/numpy/lib/shape_base.py
@@ -325,6 +325,10 @@ def dstack(tup):
     This is a simple way to stack 2D arrays (images) into a single
     3D array for processing.
 
+    This function continues to be supported for backward compatibility, but
+    you should prefer ``np.concatenate`` or ``np.stack``. The ``np.stack``
+    function was added in NumPy 1.10.
+
     Parameters
     ----------
     tup : sequence of arrays
