changeset 21162:5a02590028c6

doc: Update docstring for nargin. * ov-usr-fcn.cc (Fnargin): Update docstring.
author Rik <rik@octave.org>
date Sat, 30 Jan 2016 21:34:51 -0800
parents 4c54a269ad44
children 2d22bd38deac
files libinterp/octave-value/ov-usr-fcn.cc
diffstat 1 files changed, 5 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/octave-value/ov-usr-fcn.cc	Sat Jan 30 21:08:13 2016 -0800
+++ b/libinterp/octave-value/ov-usr-fcn.cc	Sat Jan 30 21:34:51 2016 -0800
@@ -790,8 +790,9 @@
 function.  At the top level, return the number of command line arguments\n\
 passed to Octave.\n\
 \n\
-If called with the optional argument @var{fcn}---a function name or handle---\n\
-return the declared number of arguments that the function can accept.\n\
+If called with the optional argument @var{fcn}---a function name or\n\
+handle---return the declared number of arguments that the function can\n\
+accept.\n\
 \n\
 If the last argument to @var{fcn} is @var{varargin} the returned value is\n\
 negative.  For example, the function @code{union} for sets is declared as\n\
@@ -807,7 +808,8 @@
 @end group\n\
 @end example\n\
 \n\
-Programming Note: @code{nargin} does not work on built-in functions.\n\
+Programming Note: @code{nargin} does not work on compiled functions\n\
+(@file{.oct} files) such as built-in or dynamically loaded functions.\n\
 @seealso{nargout, narginchk, varargin, inputname}\n\
 @end deftypefn")
 {