Mercurial > hg > octave-nkf
diff src/ov-usr-fcn.cc @ 14366:b76f0740940e
doc: Periodic grammar check of documentation.
* accumarray.m, repmat.m, imshow.m, strread.m, edit.m, mkoctfile.m,
warning_ids.m, glpk.m, lsqnonneg.m, optimset.m, pqpnonneg.m, figure.m, print.m,
__print_parse_opts__.m, gmres.m, zscore.m, __init_fltk__.cc, cellfun.cc,
nproc.cc, regexp.cc, spparms.cc, dirfns.cc, file-io.cc, load-save.cc,
ov-null-mat.cc, ov-usr-fcn.cc, variables.cc: Periodic grammar check of
documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 15 Feb 2012 13:31:31 -0800 |
parents | 19078011cdc3 |
children | be18c9e359bf |
line wrap: on
line diff
--- a/src/ov-usr-fcn.cc +++ b/src/ov-usr-fcn.cc @@ -702,7 +702,7 @@ Within a function, return the number of values the caller expects to\n\ receive. If called with the optional argument @var{fcn}, a function\n\ name or handle, return the number of declared output values that the\n\ -function can produce. If the final output argument is @var{varargout}\n\ +function can produce. If the final output argument is @var{varargout}\n\ the returned value is negative.\n\ \n\ For example,\n\ @@ -728,12 +728,14 @@ nargout (@@histc) \% or nargout ('histc')\n\ @end example\n\ \n\ +@noindent\n\ will return 2, because @code{histc} has two outputs, whereas\n\ \n\ @example\n\ nargout (@@deal)\n\ @end example\n\ \n\ +@noindent\n\ will return -1, because @code{deal} has a variable number of outputs.\n\ \n\ At the top level, @code{nargout} with no argument is undefined.\n\