summaryrefslogtreecommitdiff
path: root/numpy/lib/shape_base.py
diff options
context:
space:
mode:
authorSøren Fuglede Jørgensen <s@fuglede.dk>2017-03-26 20:30:51 +0200
committerGitHub <noreply@github.com>2017-03-26 20:30:51 +0200
commit20c94437ead440d85be2b5dcd19764bbf8ade926 (patch)
tree94b6bec22cef349a7ec0a7c0222d4e1aafcd9c1e /numpy/lib/shape_base.py
parent82e0860e2d126aaf2d7ab09b0da13e04b5a32658 (diff)
downloadnumpy-20c94437ead440d85be2b5dcd19764bbf8ade926.tar.gz
DOC: Spell out note for `dstack`
This adds to the documentation on `dstack` the notes from `hstack` and `vstack` about dimensionality requirements.
Diffstat (limited to 'numpy/lib/shape_base.py')
-rw-r--r--numpy/lib/shape_base.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/numpy/lib/shape_base.py b/numpy/lib/shape_base.py
index 8ebcf04b4..a0640143b 100644
--- a/numpy/lib/shape_base.py
+++ b/numpy/lib/shape_base.py
@@ -367,7 +367,8 @@ def dstack(tup):
Notes
-----
- Equivalent to ``np.concatenate(tup, axis=2)``.
+ Equivalent to ``np.concatenate(tup, axis=2)`` if `tup` contains arrays that
+ are at least 3-dimensional.
Examples
--------