summaryrefslogtreecommitdiff
path: root/numpy/lib/shape_base.py
diff options
context:
space:
mode:
authorHeshy Roskes <hroskes@jhu.edu>2020-02-20 12:50:34 -0500
committerGitHub <noreply@github.com>2020-02-20 09:50:34 -0800
commit3963ed0ea4e7d89174b1e992d84b47c0751f533f (patch)
tree8681b49dbcc123b487c8d1ff388d06a5556004b6 /numpy/lib/shape_base.py
parent473a68a53028f8a24b88bb9fc08b38dc3b69800e (diff)
downloadnumpy-3963ed0ea4e7d89174b1e992d84b47c0751f533f.tar.gz
DOC: fix documentation for apply_along_axis (#15619)
Diffstat (limited to 'numpy/lib/shape_base.py')
-rw-r--r--numpy/lib/shape_base.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/lib/shape_base.py b/numpy/lib/shape_base.py
index 7634af010..b7f1f16f2 100644
--- a/numpy/lib/shape_base.py
+++ b/numpy/lib/shape_base.py
@@ -269,8 +269,8 @@ def apply_along_axis(func1d, axis, arr, *args, **kwargs):
"""
Apply a function to 1-D slices along the given axis.
- Execute `func1d(a, *args)` where `func1d` operates on 1-D arrays and `a`
- is a 1-D slice of `arr` along `axis`.
+ Execute `func1d(a, *args, **kwargs)` where `func1d` operates on 1-D arrays
+ and `a` is a 1-D slice of `arr` along `axis`.
This is equivalent to (but faster than) the following use of `ndindex` and
`s_`, which sets each of ``ii``, ``jj``, and ``kk`` to a tuple of indices::