summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2018-03-06 19:49:20 -0700
committerGitHub <noreply@github.com>2018-03-06 19:49:20 -0700
commite3fe42f0473d41f97db5a40e3ddd067391df57f0 (patch)
tree2e02cf7cad7a37485a56e9efa24e417d3072410c
parent400607bdd44d7ad23a3fe666c796e9893b2bed46 (diff)
parent2749b32ddb98c25fda40a645a8f7ac1bfdb7f4ac (diff)
downloadpython-numpy-e3fe42f0473d41f97db5a40e3ddd067391df57f0.tar.gz
python-numpy-e3fe42f0473d41f97db5a40e3ddd067391df57f0.tar.bz2
python-numpy-e3fe42f0473d41f97db5a40e3ddd067391df57f0.zip
Merge pull request #10699 from ahaldane/fixup_gradient_docstring
DOC: Grammar of np.gradient docstring
-rw-r--r--numpy/lib/function_base.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py
index e61122107..7b0c3007b 100644
--- a/numpy/lib/function_base.py
+++ b/numpy/lib/function_base.py
@@ -818,9 +818,9 @@ def gradient(f, *varargs, **kwargs):
Notes
-----
Assuming that :math:`f\\in C^{3}` (i.e., :math:`f` has at least 3 continuous
- derivatives) and let be :math:`h_{*}` a non homogeneous stepsize, the
- spacing the finite difference coefficients are computed by minimising
- the consistency error :math:`\\eta_{i}`:
+ derivatives) and let :math:`h_{*}` be a non-homogeneous stepsize, we
+ minimize the "consistency error" :math:`\\eta_{i}` between the true gradient
+ and its estimate from a linear combination of the neighboring grid-points:
.. math::