diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2016-02-16 11:13:07 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2016-02-16 11:13:07 -0700 |
| commit | f4cc58c80df5202a743bddd514a3485d5e4ec5a4 (patch) | |
| tree | 5bcbb1f6e0e66530faee6996e35a37c9a2fa2657 | |
| parent | 5fe1f8ff319beeca186ba0d34866d67b24553066 (diff) | |
| parent | 596460b7b9062fbab4c67da9a0f90736153b78b4 (diff) | |
| download | numpy-f4cc58c80df5202a743bddd514a3485d5e4ec5a4.tar.gz | |
Merge pull request #7253 from aukejw/stack_documentation_#7183
DOC: note in h/v/dstack points users to stack/concatenate
| -rw-r--r-- | numpy/core/shape_base.py | 8 | ||||
| -rw-r--r-- | numpy/lib/shape_base.py | 4 |
2 files changed, 12 insertions, 0 deletions
diff --git a/numpy/core/shape_base.py b/numpy/core/shape_base.py index 599b48d82..31d7d1c03 100644 --- 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 index ffbe56721..63f4db68e 100644 --- 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 |