summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorderrick <myutat@gmail.com>2018-01-12 22:23:27 -0800
committerderrick <myutat@gmail.com>2018-01-12 22:23:27 -0800
commite9dd3a57b652dd13dcb3e67b222d88b51c4cdedd (patch)
tree191afa718ef47a95b4093a4e66a59b871c552c47
parentcef6c3b0573c170ba70db5b22251c8eca1575259 (diff)
downloadnumpy-e9dd3a57b652dd13dcb3e67b222d88b51c4cdedd.tar.gz
DOC: See #7968
-rw-r--r--numpy/add_newdocs.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 8fc36dd9c..7dfecdb80 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -1232,7 +1232,8 @@ add_newdoc('numpy.core.multiarray', 'concatenate',
The arrays must have the same shape, except in the dimension
corresponding to `axis` (the first, by default).
axis : int, optional
- The axis along which the arrays will be joined. Default is 0.
+ The axis along which the arrays will be joined. If axis is None,
+ arrays are flattened before use. Default is 0.
out : ndarray, optional
If provided, the destination to place the result. The shape must be
correct, matching that of what concatenate would have returned if no
@@ -1276,6 +1277,8 @@ add_newdoc('numpy.core.multiarray', 'concatenate',
>>> np.concatenate((a, b.T), axis=1)
array([[1, 2, 5],
[3, 4, 6]])
+ >>> np.concatenate((a, b), axis=None)
+ array([1, 2, 3, 4, 5, 6])
This function will not preserve masking of MaskedArray inputs.