Mercurial > hg > octave-nkf
diff scripts/general/gradient.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 18 Jul 2010 20:35:16 -0700 |
| parents | d1978e7364ad |
| children | a8ac114ec9ab |
line wrap: on
line diff
--- a/scripts/general/gradient.m +++ b/scripts/general/gradient.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{dx} =} gradient (@var{m}) +## @deftypefn {Function File} {@var{dx} =} gradient (@var{m}) ## @deftypefnx {Function File} {[@var{dx}, @var{dy}, @var{dz}, @dots{}] =} gradient (@var{m}) ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{s}) ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{x}, @var{y}, @var{z}, @dots{}) @@ -38,8 +38,10 @@ ## @var{s} parameter. If @var{s} is a scalar, it is assumed to be the spacing ## for all dimensions. ## Otherwise, separate values of the spacing can be supplied by -## the @var{x}, @dots{} arguments. Scalar values specify an equidistant spacing. -## Vector values for the @var{x}, @dots{} arguments specify the coordinate for that +## the @var{x}, @dots{} arguments. Scalar values specify an equidistant +## spacing. +## Vector values for the @var{x}, @dots{} arguments specify the coordinate for +## that ## dimension. The length must match their respective dimension of @var{m}. ## ## At boundary points a linear extrapolation is applied. Interior points