Mercurial > jwe > octave
comparison libinterp/corefcn/data.cc @ 31146:9e9f5f1e8ec2
doc: Update plus() function to use inputs A, B.
* data.cc (Fplus): Use @var{A}, @var{B} in docstring for consistency with other
operator functions.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 11 Jul 2022 22:46:33 -0700 |
parents | 670a0d878af1 |
children |
comparison
equal
deleted
inserted
replaced
31145:7c5cb8f8a21e | 31146:9e9f5f1e8ec2 |
---|---|
6468 return retval; | 6468 return retval; |
6469 } | 6469 } |
6470 | 6470 |
6471 DEFUN (plus, args, , | 6471 DEFUN (plus, args, , |
6472 doc: /* -*- texinfo -*- | 6472 doc: /* -*- texinfo -*- |
6473 @deftypefn {} {@var{z} =} plus (@var{x}, @var{y}) | 6473 @deftypefn {} {@var{C} =} plus (@var{A}, @var{B}) |
6474 @deftypefnx {} {@var{z} =} plus (@var{x1}, @var{x2}, @dots{}) | 6474 @deftypefnx {} {@var{C} =} plus (@var{A1}, @var{A2}, @dots{}) |
6475 This function and @w{@tcode{@var{x} + @var{y}}} are equivalent. | 6475 This function and @w{@tcode{@var{A} + @var{B}}} are equivalent. |
6476 | 6476 |
6477 If more arguments are given, the summation is applied | 6477 If more arguments are given, the summation is applied |
6478 cumulatively from left to right: | 6478 cumulatively from left to right: |
6479 | 6479 |
6480 @example | 6480 @example |
6481 (@dots{}((@var{x1} + @var{x2}) + @var{x3}) + @dots{}) | 6481 (@dots{}((@var{A1} + @var{A2}) + @var{A3}) + @dots{}) |
6482 @end example | 6482 @end example |
6483 | 6483 |
6484 @seealso{minus, uplus} | 6484 @seealso{minus, uplus} |
6485 @end deftypefn */) | 6485 @end deftypefn */) |
6486 { | 6486 { |