summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorOleg Zabluda <ozabluda@gmail.com>2017-10-05 22:39:22 -0700
committerEric Wieser <wieser.eric@gmail.com>2017-10-05 22:39:22 -0700
commit6af2c42992f872233489ad00c5ac06ce5a430022 (patch)
treeed40e101a9c434e6380b3f61202403bae7fa13df /numpy/add_newdocs.py
parent50e33f952247b482884fa2ea2dc59865e122ec2d (diff)
downloadnumpy-6af2c42992f872233489ad00c5ac06ce5a430022.tar.gz
DOC: Improve documentation of axis parameter in numpy.unpackbits (#9828)
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index fd6fe277f..e35337476 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -5395,8 +5395,9 @@ add_newdoc('numpy.core.multiarray', 'unpackbits',
myarray : ndarray, uint8 type
Input array.
axis : int, optional
- Unpacks along this axis.
-
+ The dimension over which bit-unpacking is done.
+ ``None`` implies unpacking the flattened array.
+
Returns
-------
unpacked : ndarray, uint8 type