Mercurial > hg > octave-nkf
changeset 10848:d782d7b524a6
document the nargout=0 exception in isargout
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Tue, 03 Aug 2010 09:40:52 +0200 |
| parents | 7fa3c8e43357 |
| children | f1a45913662a |
| files | src/ov-usr-fcn.cc |
| diffstat | 1 files changed, 2 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ov-usr-fcn.cc +++ b/src/ov-usr-fcn.cc @@ -751,11 +751,11 @@ DEFUN (isargout, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isargout (@var{k})\n\ -Within a function, given an index @var{k} within the range @code{1:nargout},\n\ +Within a function, given an index @var{k} within the range @code{1:max(nargout,1)},\n\ return a logical value indicating whether the argument will be assigned on\n\ output to a variable or cell or struct element. If the result is false,\n\ the argument will be ignored using the tilde (~) special output argument.\n\ -If @var{k} is outside the range @code{1:nargout}, the function yields false.\n\ +If @var{k} is outside the range @code{1:max(nargout,1)}, the function yields false.\n\ @var{k} can also be an array, in\n\ which case the function works element-wise and a logical array is returned.\n\ At the top level, @code{isargout} returns an error.\n\