summaryrefslogtreecommitdiff
path: root/numpy/doc/byteswapping.py
diff options
context:
space:
mode:
authorDavid M Fobes <pseudocubic@gmail.com>2014-10-14 13:09:58 -0400
committerDavid M Fobes <pseudocubic@gmail.com>2014-10-16 12:53:20 -0400
commit8969da59ea9803b81b0dcb2fab3f41d4b168bc68 (patch)
tree2a6f8276f2c25afa704e04942cf51a99d44f8d2b /numpy/doc/byteswapping.py
parent51f0976c1ca101a01d09e26ee5dfea5360f73c63 (diff)
downloadnumpy-8969da59ea9803b81b0dcb2fab3f41d4b168bc68.tar.gz
BUG: Fixes #5184 gradient calculation behavior at boundaries
* Previous expected behavior was that the gradient is computed using central differences in the interior and first differences at the boundaries. * gradient was updated in v1.9.0 so that second-order accurate calculations are done at the boundaries, but this breaks expected behavior with old code, so `edge_order` keyword (Default: 1) is added to specify whether first or second order calculations at the boundaries should be used. * Since the second argument is *varargs, in order to maintain compatibility with old code and compatibility with python 2.6 & 2.7, **kwargs is used, and all kwargs that are not `edge_order` raise an error, listing the offending kwargs. * Tests and documentation updated to reflect this change. * Added `.. versionadded:: 1.9.1` to the new optional kwarg `edge_order` documentation, and specified supported `edge_order` kwarg values. * Clarified documentation for `varargs`. * Made indentation in docstring consistent with other docstring styles. * Examples corrected
Diffstat (limited to 'numpy/doc/byteswapping.py')
0 files changed, 0 insertions, 0 deletions