summaryrefslogtreecommitdiff
path: root/numpy/lib/function_base.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-10-01 14:23:27 -0600
committerCharles Harris <charlesr.harris@gmail.com>2015-10-01 14:23:27 -0600
commit91e16f63474b43cd586e1a61e50285032f39a256 (patch)
treec06b69ccbee84bcb26a9f0016192a86e6c1e19f2 /numpy/lib/function_base.py
parent2bc213bb3a75069775bc2a6cbc43dc26e1664835 (diff)
parenta3c1ed6dbba1e23bcbe30040bfa3d63e91b2cdab (diff)
downloadnumpy-91e16f63474b43cd586e1a61e50285032f39a256.tar.gz
Merge pull request #6322 from pizzathief/issue5900
DOC: numpy.diff docstring changed as per recommendation on
Diffstat (limited to 'numpy/lib/function_base.py')
-rw-r--r--numpy/lib/function_base.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py
index 007ff42a4..3c941ca5b 100644
--- a/numpy/lib/function_base.py
+++ b/numpy/lib/function_base.py
@@ -1316,10 +1316,10 @@ def gradient(f, *varargs, **kwargs):
def diff(a, n=1, axis=-1):
"""
- Calculate the n-th order discrete difference along given axis.
+ Calculate the n-th discrete difference along given axis.
- The first order difference is given by ``out[n] = a[n+1] - a[n]`` along
- the given axis, higher order differences are calculated by using `diff`
+ The first difference is given by ``out[n] = a[n+1] - a[n]`` along
+ the given axis, higher differences are calculated by using `diff`
recursively.
Parameters
@@ -1334,8 +1334,9 @@ def diff(a, n=1, axis=-1):
Returns
-------
diff : ndarray
- The `n` order differences. The shape of the output is the same as `a`
+ The n-th differences. The shape of the output is the same as `a`
except along `axis` where the dimension is smaller by `n`.
+.
See Also
--------