Mercurial > octave-nkf
changeset 10711:fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
line wrap: on
line diff
--- a/doc/ChangeLog Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/ChangeLog Wed Jun 16 20:36:55 2010 -0700 @@ -1,3 +1,9 @@ +2010-06-16 Rik <octave@nomad.inbox5.com> + + * interpreter/expr.txi, interpreter/func.txi, interpreter/install.txi, + interpreter/plot.txi, interpreter/sparse.txi: Periodic grammar check + of documentation to ensure a common format. + 2010-05-27 Rik <octave@nomad.inbox5.com> * interpreter/arith.txi, interpreter/diffeq.txi, interpreter/intro.txi, @@ -313,8 +319,8 @@ 2009-10-23 Rik <octave@nomad.inbox5.com> - * various: Periodic grammar check of Octave documentation files to ensure - a standardized format. + * various: Periodic grammar check of Octave documentation files to + ensure a standardized format. 2009-10-20 Rik <octave@nomad.inbox5.com>
--- a/doc/interpreter/expr.txi Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/interpreter/expr.txi Wed Jun 16 20:36:55 2010 -0700 @@ -826,7 +826,7 @@ arguments because Octave would be forced to try to evaluate both of the operands for the operator @samp{&}. -The ternary operator (?:) is not supported in Octave. If short-circuiting is +The ternary operator (?:) is not supported in Octave. If short-circuiting is not important, it can be replaced by the @code{ifelse} function. @DOCSTRING(ifelse)
--- a/doc/interpreter/func.txi Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/interpreter/func.txi Wed Jun 16 20:36:55 2010 -0700 @@ -441,7 +441,7 @@ @section Ignoring Arguments In the formal argument list, it is possible to use the dummy placeholder @code{~} -instead of a name. This indicates that the corresponding argument value should be ignored +instead of a name. This indicates that the corresponding argument value should be ignored and not stored to any variable. @example
--- a/doc/interpreter/install.txi Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/interpreter/install.txi Wed Jun 16 20:36:55 2010 -0700 @@ -123,7 +123,7 @@ Don't use CXSPARSE, disable some sparse matrix functionality. @item --without-umfpack -Don't use UMFPACK, disable some sparse matrix functionality. +Don't use @sc{umfpack}, disable some sparse matrix functionality. @item --without-fftw Use the included @sc{fftpack} library instead of the @sc{fftw} library.
--- a/doc/interpreter/plot.txi Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/interpreter/plot.txi Wed Jun 16 20:36:55 2010 -0700 @@ -1240,7 +1240,7 @@ @item currentobject @item currentpoint Holds the coordinates of the point over which the mouse pointer was when -the mouse button was pressed. If a mouse callback function is defined, +the mouse button was pressed. If a mouse callback function is defined, @code{"currentpoint"} holds the coordinates of the point over which the mouse pointer is when the function gets called. @item deletefcn @@ -1259,10 +1259,10 @@ @item keypressfcn see @code{"keypressfcn"} @item keyreleasefcn -With @code{"keypressfcn"}, The keyboard callback functions. These +With @code{"keypressfcn"}, The keyboard callback functions. These callback functions get called when a key is pressed/released -respectively. The functions are called with two input arguments. The -first argument holds the handle of the calling figure. The second +respectively. The functions are called with two input arguments. The +first argument holds the handle of the calling figure. The second argument holds the event structure which has the following members: @table @code @item Character @@ -1271,7 +1271,7 @@ lowercase value of the key @item Modifier A cell array containing strings representing the modifiers pressed with -the key. Possible values are @code{"shift"}, @code{"alt"}, and +the key. Possible values are @code{"shift"}, @code{"alt"}, and @code{"control"}. @end table @item menubar @@ -1319,8 +1319,8 @@ See @code{"windowbuttonupfcn"} @item windowbuttonupfcn With @code{"windowbuttondownfcn"} and @code{"windowbuttonmotionfcn"}, -The mouse callback functions. These callback functions get called when -the mouse button is pressed, dragged, and released respectively. When +The mouse callback functions. These callback functions get called when +the mouse button is pressed, dragged, and released respectively. When these callback functions are called, the @code{"currentpoint"} property holds the current coordinates of the cursor. @item windowbuttonwheelfcn @@ -1372,7 +1372,7 @@ @item createfcn @item currentpoint Holds the coordinates of the point over which the mouse pointer was when -the mouse button was pressed. If a mouse callback function is defined, +the mouse button was pressed. If a mouse callback function is defined, @code{"currentpoint"} holds the coordinates of the point over which the mouse pointer is when the function gets called. @item dataaspectratio @@ -1397,12 +1397,12 @@ @item interpreter @item interruptible @item key -Toggle display of the legend. --- Values: "on," "off" +Toggle display of the legend. --- Values: "on," "off" Note that this property is not compatible with @sc{matlab} and may be removed in a future version of Octave. @item keybox Toggle display of a box around the -legend. --- Values: "on," "off" +legend. --- Values: "on," "off" Note that this property is not compatible with @sc{matlab} and may be removed in a future version of Octave. @item keypos
--- a/doc/interpreter/sparse.txi Wed Jun 16 23:45:13 2010 +0200 +++ b/doc/interpreter/sparse.txi Wed Jun 16 20:36:55 2010 -0700 @@ -790,7 +790,7 @@ @item If the sparse Cholesky factorization failed or the matrix is not hermitian with a real positive diagonal, and the matrix is square, factorize -using UMFPACK. +using @sc{umfpack}. @item If the matrix is not square, or any of the previous solvers flags a singular or near singular matrix, find a minimum norm solution using
--- a/liboctave/ChangeLog Wed Jun 16 23:45:13 2010 +0200 +++ b/liboctave/ChangeLog Wed Jun 16 20:36:55 2010 -0700 @@ -1,3 +1,7 @@ +2010-06-16 Rik <octave@nomad.inbox5.com> + + * DASSL-opts.in: Periodic grammar check on documentation. + 2010-06-16 David Bateman <dbateman@free.fr> * oct-rand.cc (void octave_rand:do_reset (void),
--- a/liboctave/DASSL-opts.in Wed Jun 16 23:45:13 2010 +0200 +++ b/liboctave/DASSL-opts.in Wed Jun 16 20:36:55 2010 -0700 @@ -97,7 +97,7 @@ NAME = "enforce nonnegativity constraints" DOC_ITEM If you know that the solutions to your equations will always be -nonnegative, it may help to set this parameter to a nonzero +non-negative, it may help to set this parameter to a nonzero value. However, it is probably best to try leaving this option set to zero first, and only setting it to a nonzero value if that doesn't work very well.
--- a/scripts/@ftp/dir.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/@ftp/dir.m Wed Jun 16 20:36:55 2010 -0700 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{lst} =} dir (@var{path}) ## List the current directory in verbose form for the FTP connection -## @var{f}. @var{f} is an FTP object returned by the ftp function. +## @var{f}. @var{f} is an FTP object returned by the ftp function. ## @end deftypefn function lst = dir (obj)
--- a/scripts/@ftp/ftp.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/@ftp/ftp.m Wed Jun 16 20:36:55 2010 -0700 @@ -18,7 +18,7 @@ ## @deftypefnx {Function File} {@var{f}} = ftp (@var{host}, @var{username}, ## @var{password}) ## Connect to the FTP server @var{host} with @var{username} and @var{password}. ## If @var{username} and @var{password} are not specified, user "anonymous" -## with no password is used. The returned FTP object @var{f} represents the +## with no password is used. The returned FTP object @var{f} represents the ## established FTP connection. ## @end deftypefn
--- a/scripts/@ftp/mget.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/@ftp/mget.m Wed Jun 16 20:36:55 2010 -0700 @@ -18,7 +18,7 @@ ## @deftypefnx {Function File} {} mget (@var{f}, @var{dir}) ## @deftypefnx {Function File} {} mget (@dots{}, @var{target}) ## Downloads a remote file @var{file} or directory @var{dir} to the local -## directory on the FTP connection @var{f}. @var{f} is an FTP object +## directory on the FTP connection @var{f}. @var{f} is an FTP object ## returned by the ftp function. ## ## The arguments @var{file} and @var{dir} can include wildcards and any
--- a/scripts/@ftp/mput.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/@ftp/mput.m Wed Jun 16 20:36:55 2010 -0700 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} mput (@var{f}, @var{file}) ## Upload the local file @var{file} into the current remote directory on -## the FTP connection @var{f}. @var{f} is an FTP object returned by the +## the FTP connection @var{f}. @var{f} is an FTP object returned by the ## ftp function. ## ## The argument @var{file} is passed by the @dfn{glob} function and any
--- a/scripts/@ftp/rename.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/@ftp/rename.m Wed Jun 16 20:36:55 2010 -0700 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} rename (@var{f}, @var{oldname}, @var{newname}) ## Rename or move the remote file or directory @var{oldname} to @var{newname}, -## over the FTP connection @var{f}. @var{f} is an FTP object returned by the +## over the FTP connection @var{f}. @var{f} is an FTP object returned by the ## ftp function. ## @end deftypefn
--- a/scripts/ChangeLog Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/ChangeLog Wed Jun 16 20:36:55 2010 -0700 @@ -1,3 +1,14 @@ +2010-06-16 Rik <octave@nomad.inbox5.com> + + * @ftp/dir.m, @ftp/ftp.m, @ftp/mget.m, @ftp/mput.m, @ftp/rename.m, + deprecated/fstat.m, general/accumdim.m, general/interp1.m, + linear-algebra/ishermitian.m, linear-algebra/issymmetric.m, + miscellaneous/substruct.m, optimization/fminbnd.m, + optimization/fsolve.m, plot/bar.m, plot/daspect.m, plot/pbaspect.m, + plot/print.m, polynomial/mkpp.m, polynomial/ppval.m, set/union.m, + signal/unwrap.m, specfun/nthroot.m: Periodic grammar check of + documentation to ensure a common format. + 2010-06-14 Rik <octave@nomad.inbox5.com> * plot/image.m: Flip data, rather than y-axis, for images. (bug #30033)
--- a/scripts/deprecated/fstat.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/deprecated/fstat.m Wed Jun 16 20:36:55 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{info}, @var{err}, @var{msg}] = } fstat (fid) +## @deftypefn {Function File} {[@var{info}, @var{err}, @var{msg}] =} fstat (fid) ## This function has been deprecated. Use stat instead. ## @end deftypefn
--- a/scripts/general/accumdim.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/general/accumdim.m Wed Jun 16 20:36:55 2010 -0700 @@ -21,7 +21,7 @@ ## Create an array by accumulating the slices of an array into the ## positions defined by their subscripts along a specified dimension. ## The subscripts are defined by the index vector @var{subs}. -## The dimension is specified by @var{dim}. If not given, it defaults +## The dimension is specified by @var{dim}. If not given, it defaults ## to the first non-singleton dimension. ## ## The extent of the result matrix in the working dimension will be determined
--- a/scripts/general/interp1.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/general/interp1.m Wed Jun 16 20:36:55 2010 -0700 @@ -60,7 +60,7 @@ ## @var{y}, @var{method}, 'pp'), @var{xi}) == interp1 (@var{x}, @var{y}, ## @var{xi}, @var{method}, 'extrap')}. ## -## Duplicate points in @var{x} specify a discontinuous interpolant. There +## Duplicate points in @var{x} specify a discontinuous interpolant. There ## should be at most 2 consecutive points with the same value. ## The discontinuous interpolant is right-continuous if @var{x} is increasing, ## left-continuous if it is decreasing.
--- a/scripts/linear-algebra/ishermitian.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/linear-algebra/ishermitian.m Wed Jun 16 20:36:55 2010 -0700 @@ -21,7 +21,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol}) ## Return true if @var{x} is symmetric within the tolerance specified by @var{tol}, -## otherwise return false. The default tolerance is zero (uses faster code). +## otherwise return false. The default tolerance is zero (uses faster code). ## Matrix @var{x} is considered symmetric if ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. ## @seealso{size, rows, columns, length, ismatrix, isscalar,
--- a/scripts/linear-algebra/issymmetric.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/linear-algebra/issymmetric.m Wed Jun 16 20:36:55 2010 -0700 @@ -21,7 +21,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} issymmetric (@var{x}, @var{tol}) ## Return true if @var{x} is a symmetric matrix within the tolerance specified -## by @var{tol}, otherwise return false. The default tolerance is zero (uses +## by @var{tol}, otherwise return false. The default tolerance is zero (uses ## faster code). ## Matrix @var{x} is considered symmetric if ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}.
--- a/scripts/miscellaneous/substruct.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/miscellaneous/substruct.m Wed Jun 16 20:36:55 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} substruct (@var{type}, @var{subs}, @dots{}) ## Create a subscript structure for use with @code{subsref} or -## @code{subsasgn}. For example: +## @code{subsasgn}. For example: ## ## @example ## @group
--- a/scripts/optimization/fminbnd.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/optimization/fminbnd.m Wed Jun 16 20:36:55 2010 -0700 @@ -21,7 +21,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{x}, @var{fval}, @var{info}, @var{output}] =} fminbnd (@var{fun}, @var{a}, @var{b}, @var{options}) ## Find a minimum point of a univariate function. @var{fun} should be a function -## handle or name. @var{a}, @var{b} specify a starting interval. @var{options} is a +## handle or name. @var{a}, @var{b} specify a starting interval. @var{options} is a ## structure specifying additional options. Currently, @code{fminbnd} ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}.
--- a/scripts/optimization/fsolve.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/optimization/fsolve.m Wed Jun 16 20:36:55 2010 -0700 @@ -44,8 +44,8 @@ ## for both @code{"TolX"} and @code{"TolFun"}. ## ## If @code{"AutoScaling"} is on, the variables will be automatically scaled -## according to the column norms of the (estimated) Jacobian. As a result, -## TolF becomes scaling-independent. By default, this option is off, because +## according to the column norms of the (estimated) Jacobian. As a result, +## TolF becomes scaling-independent. By default, this option is off, because ## it may sometimes deliver unexpected (though mathematically correct) results. ## ## If @code{"Updating"} is "on", the function will attempt to use Broyden
--- a/scripts/plot/bar.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/plot/bar.m Wed Jun 16 20:36:55 2010 -0700 @@ -66,7 +66,7 @@ ## @end group ## @end example ## -## will change the colors used for the bars. If you wish to force the bars to +## will change the colors used for the bars. If you wish to force the bars to ## particular colors, this can be achieved like ## ## @example
--- a/scripts/plot/daspect.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/plot/daspect.m Wed Jun 16 20:36:55 2010 -0700 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) -## Set the data aspect ratio of the current axes. The aspect ratio is +## Set the data aspect ratio of the current axes. The aspect ratio is ## a normalized 3 element vector representing the span of the x, y, and ## z-axes limits. ## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( )
--- a/scripts/plot/pbaspect.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/plot/pbaspect.m Wed Jun 16 20:36:55 2010 -0700 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} pbaspect (@var{plot_box_aspect_ratio}) -## Set the plot box aspect ratio of the current axes. The aspect ratio +## Set the plot box aspect ratio of the current axes. The aspect ratio ## is a normalized 3 element vector representing the rendered lengths of ## the x, y, and z-axes. ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( )
--- a/scripts/plot/print.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/plot/print.m Wed Jun 16 20:36:55 2010 -0700 @@ -142,7 +142,7 @@ ## "paperposition" property. ## ## @itemx -append -## Appends the output to a pre-existing file. Presently only PDF, +## Appends the output to a pre-existing file. Presently only PDF, ## and Postscript files are supported. ## ## @itemx -r@var{NUM}
--- a/scripts/polynomial/mkpp.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/polynomial/mkpp.m Wed Jun 16 20:36:55 2010 -0700 @@ -28,8 +28,8 @@ ## @code{rows (@var{p}) == length (@var{x}) - 1}. ## ## @var{p} may also be a multi-dimensional array, specifying a vector-valued -## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} is -## not given, the default is @code{size (p)(1:end-2)}. If @var{d} is given, the +## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} is +## not given, the default is @code{size (p)(1:end-2)}. If @var{d} is given, the ## leading dimensions of @var{p} are reshaped to conform to @var{d}. ## ## @seealso{unmkpp, ppval, spline}
--- a/scripts/polynomial/ppval.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/polynomial/ppval.m Wed Jun 16 20:36:55 2010 -0700 @@ -22,7 +22,7 @@ ## If @var{pp} is scalar-valued, the result is an array of the same shape as @var{xi}. ## Otherwise, the size of the result is @code{[pp.d, length(@var{xi})]} if ## @var{xi} is a vector, or @code{[pp.d, size(@var{xi})]} if it is a multi-dimensional -## array. If pp.orient is 1, the dimensions are permuted as in interp1, to +## array. If pp.orient is 1, the dimensions are permuted as in interp1, to ## @code{[pp.d, length(@var{xi})]} and @code{[pp.d, size(@var{xi})]} respectively. ## @seealso{mkpp, unmkpp, spline} ## @end deftypefn
--- a/scripts/set/union.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/set/union.m Wed Jun 16 20:36:55 2010 -0700 @@ -22,7 +22,7 @@ ## @deftypefn {Function File} {} union (@var{a}, @var{b}) ## @deftypefnx{Function File} {} union (@var{a}, @var{b}, "rows") ## Return the set of elements that are in either of the sets @var{a} and -## @var{b}. @var{a}, @var{b} may be cell arrays of string(s). +## @var{b}. @var{a}, @var{b} may be cell arrays of string(s). ## For example, ## ## @example
--- a/scripts/signal/unwrap.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/signal/unwrap.m Wed Jun 16 20:36:55 2010 -0700 @@ -24,7 +24,7 @@ ## Unwrap radian phases by adding multiples of 2*pi as appropriate to ## remove jumps greater than @var{tol}. @var{tol} defaults to pi. ## -## Unwrap will work along the the dimension @var{dim}. If @var{dim} +## Unwrap will work along the dimension @var{dim}. If @var{dim} ## is unspecified it defaults to the first non-singleton dimension. ## @end deftypefn
--- a/scripts/specfun/nthroot.m Wed Jun 16 23:45:13 2010 +0200 +++ b/scripts/specfun/nthroot.m Wed Jun 16 20:36:55 2010 -0700 @@ -35,7 +35,7 @@ ## @end group ## @end example ## -## @var{n} must be a scalar. If @var{n} is not an even integer and @var{X} has +## @var{n} must be a scalar. If @var{n} is not an even integer and @var{X} has ## negative entries, an error is produced. ## ## @end deftypefn
--- a/src/ChangeLog Wed Jun 16 23:45:13 2010 +0200 +++ b/src/ChangeLog Wed Jun 16 20:36:55 2010 -0700 @@ -1,3 +1,12 @@ +2010-06-16 Rik <octave@nomad.inbox5.com> + + * DLD-FUNCTIONS/cellfun.cc, DLD-FUNCTIONS/dot.cc, + DLD-FUNCTIONS/gammainc.cc, DLD-FUNCTIONS/lookup.cc, + DLD-FUNCTIONS/lu.cc, DLD-FUNCTIONS/luinc.cc, DLD-FUNCTIONS/onCleanup.cc, + DLD-FUNCTIONS/sparse.cc, DLD-FUNCTIONS/spparms.cc, DLD-FUNCTIONS/svd.cc, + data.cc, dirfns.cc, graphics.cc, mappers.cc, ov-cell.cc, ov-range.cc: + Periodic grammar check of documentation to ensure a common format. + 2010-06-11 David Bateman <dbateman@free.fr> * DLD-FUNCTIONS/rand.cc : Add "reset" flag to reset the random
--- a/src/DLD-FUNCTIONS/cellfun.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/cellfun.cc Wed Jun 16 20:36:55 2010 -0700 @@ -1349,7 +1349,7 @@ @end group\n\ @end example\n\ \n\ -The position of the index is determined by @var{dim}. If not specified, slicing\n\ +The position of the index is determined by @var{dim}. If not specified, slicing\n\ is done along the first non-singleton dimension.\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/dot.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/dot.cc Wed Jun 16 20:36:55 2010 -0700 @@ -240,16 +240,18 @@ DEFUN_DLD (blkmm, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} blkmm (@var{x}, @var{y})\n\ -Computes products of matrix blocks. The blocks are given as\n\ +Computes products of matrix blocks. The blocks are given as\n\ 2-dimensional subarrays of the arrays @var{x}, @var{y}.\n\ The size of @var{x} must have the form @code{[m,k,@dots{}]} and\n\ -size of @var{y} must be @code{[k,n,@dots{}]}. The result is\n\ +size of @var{y} must be @code{[k,n,@dots{}]}. The result is\n\ then of size @code{[m,n,@dots{}]} and is computed as follows:\n\ \n\ @example\n\ +@group\n\ for i = 1:prod (size (@var{x})(3:end))\n\ @var{z}(:,:,i) = @var{x}(:,:,i) * @var{y}(:,:,i)\n\ endfor\n\ +@end group\n\ @end example\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/gammainc.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/gammainc.cc Wed Jun 16 20:36:55 2010 -0700 @@ -65,8 +65,8 @@ @var{a} must agree, and @var{gammainc} is applied element-by-element.\n\ \n\ By default the incomplete gamma function integrated from 0 to @var{x} is\n\ -computed. If \"upper\" is given then the complementary function integrated\n\ -for @var{x} to infinity is calculated. It should be noted that\n\ +computed. If \"upper\" is given then the complementary function integrated\n\ +for @var{x} to infinity is calculated. It should be noted that\n\ \n\ @example\n\ gammainc (@var{x}, @var{a}) = 1 - gammainc (@var{x}, @var{a}, \"upper\")\n\
--- a/src/DLD-FUNCTIONS/lookup.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/lookup.cc Wed Jun 16 20:36:55 2010 -0700 @@ -204,7 +204,7 @@ @var{table} contains a NaN.\n\ \n\ The complexity of the lookup is O(M*log(N)) where N is the size of @var{table}\n\ -and M is the size of @var{y}. In the special case when @var{y} is also sorted,\n\ +and M is the size of @var{y}. In the special case when @var{y} is also sorted,\n\ the complexity is O(min(M*log(N),M+N)).\n\ \n\ @var{table} and @var{y} can also be cell arrays of strings\n\
--- a/src/DLD-FUNCTIONS/lu.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/lu.cc Wed Jun 16 20:36:55 2010 -0700 @@ -73,7 +73,7 @@ @deftypefnx {Loadable Function} {[@dots{}] =} lu (@dots{}, 'vector')\n\ @cindex LU decomposition\n\ Compute the LU decomposition of @var{a}. If @var{a} is full subroutines from\n\ -@sc{lapack} are used and if @var{a} is sparse then UMFPACK is used. The\n\ +@sc{lapack} are used and if @var{a} is sparse then @sc{umfpack} is used. The\n\ result is returned in a permuted form, according to the optional return\n\ value @var{p}. For example, given the matrix @code{a = [1, 2; 3, 4]},\n\ \n\ @@ -118,9 +118,9 @@ \n\ An additional input argument @var{thres}, that defines the pivoting\n\ threshold can be given. @var{thres} can be a scalar, in which case\n\ -it defines UMFPACK pivoting tolerance for both symmetric and unsymmetric\n\ +it defines @sc{umfpack} pivoting tolerance for both symmetric and unsymmetric\n\ cases. If @var{thres} is a two element vector, then the first element\n\ -defines the pivoting tolerance for the unsymmetric UMFPACK pivoting\n\ +defines the pivoting tolerance for the unsymmetric @sc{umfpack} pivoting\n\ strategy and the second the symmetric strategy. By default, the values\n\ defined by @code{spparms} are used and are by default @code{[0.1, 0.001]}.\n\ \n\
--- a/src/DLD-FUNCTIONS/luinc.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/luinc.cc Wed Jun 16 20:36:55 2010 -0700 @@ -54,7 +54,7 @@ \n\ Alternatively, the fill-in of the incomplete LU factorization can\n\ be controlled through the variable @var{droptol} or the structure\n\ -@var{opts}. The UMFPACK multifrontal factorization code by Tim A.\n\ +@var{opts}. The @sc{umfpack} multifrontal factorization code by Tim A.\n\ Davis is used for the incomplete LU factorization, (availability\n\ @url{http://www.cise.ufl.edu/research/sparse/umfpack/})\n\ \n\
--- a/src/DLD-FUNCTIONS/onCleanup.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/onCleanup.cc Wed Jun 16 20:36:55 2010 -0700 @@ -252,7 +252,7 @@ Creates a special object that executes a given function upon destruction.\n\ If the object is copied to multiple variables (or cell or struct array elements)\n\ or returned from a function, @var{action} will be executed after clearing the last\n\ -copy of the object. Note that if multiple local onCleanup variables are created, the\n\ +copy of the object. Note that if multiple local onCleanup variables are created, the\n\ order in which they are called is unspecified.\n\ @seealso{unwind_protect}\n\ @end deftypefn")
--- a/src/DLD-FUNCTIONS/sparse.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/sparse.cc Wed Jun 16 20:36:55 2010 -0700 @@ -208,8 +208,8 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\ Creates a @var{m}-by-@var{n} sparse matrix with preallocated space for at most\n\ -@var{nz} nonzero elements. This is useful for building the matrix incrementally\n\ -by a sequence of indexed assignments. Subsequent indexed assignments will reuse\n\ +@var{nz} nonzero elements. This is useful for building the matrix incrementally\n\ +by a sequence of indexed assignments. Subsequent indexed assignments will reuse\n\ the pre-allocated memory, provided they are of one of the simple forms\n\ \n\ @itemize\n\ @@ -227,7 +227,7 @@ @end itemize\n\ \n\ Partial movement of data may still occur, but in general the assignment will be more\n\ -memory and time-efficient under these circumstances. In particular, it is possible\n\ +memory and time-efficient under these circumstances. In particular, it is possible\n\ to efficiently build a pre-allocated sparse matrix from contiguous block of columns.\n\ \n\ The amount of preallocated memory for a given matrix may be queried using the function\n\
--- a/src/DLD-FUNCTIONS/spparms.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/spparms.cc Wed Jun 16 20:36:55 2010 -0700 @@ -71,14 +71,14 @@ Flag whether the LU and the '\\' and '/' operators will automatically\n\ use the sparsity preserving amd functions (default 1)\n\ @item piv_tol\n\ -The pivot tolerance of the UMFPACK solvers (default 0.1)\n\ +The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ @item sym_tol\n\ -The pivot tolerance of the UMFPACK symmetric solvers (default 0.001)\n\ +The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ @item bandden\n\ The density of non-zero elements in a banded matrix before it is treated\n\ by the @sc{lapack} banded solvers (default 0.5)\n\ @item umfpack\n\ -Flag whether the UMFPACK or mmd solvers are used for the LU, '\\' and\n\ +Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ '/' operations (default 1)\n\ @end table\n\ \n\
--- a/src/DLD-FUNCTIONS/svd.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/DLD-FUNCTIONS/svd.cc Wed Jun 16 20:36:55 2010 -0700 @@ -407,8 +407,8 @@ DEFUN_DLD (svd_driver, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{old} =} svd_driver (@var{new})\n\ -Sets or queries the underlying LAPACK driver used by svd.\n\ -Currently recognized are \"gesvd\" and \"gesdd\". Default is \"gesvd\".\n\ +Sets or queries the underlying @sc{lapack} driver used by svd.\n\ +Currently recognized are \"gesvd\" and \"gesdd\". Default is \"gesvd\".\n\ @seealso{svd}\n\ @end deftypefn") {
--- a/src/data.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/data.cc Wed Jun 16 20:36:55 2010 -0700 @@ -338,7 +338,7 @@ DEFUN (hypot, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} hypot (@var{x}, @var{y})\n\ -@deftypefnx {Built-in Function} {} hypot (@var{x}, @var{y}, @var{z}, ...)\n\ +@deftypefnx {Built-in Function} {} hypot (@var{x}, @var{y}, @var{z}, @dots{})\n\ Compute the element-by-element square root of the sum of the squares of\n\ @var{x} and @var{y}. This is equivalent to\n\ @code{sqrt (@var{x}.^2 + @var{y}.^2)}, but calculated in a manner that\n\ @@ -346,8 +346,10 @@ @code{hypot} can also be called with more than 2 arguments; in this case,\n\ the arguments are accumulated from left to right:\n\ @example\n\ +@group\n\ hypot (hypot (@var{x}, @var{y}), @var{z})\n\ - hypot (hypot (hypot (@var{x}, @var{y}), @var{z}), @var{w}) etc.\n\ + hypot (hypot (hypot (@var{x}, @var{y}), @var{z}), @var{w}), etc.\n\ +@end group\n\ @end example\n\ @end deftypefn") { @@ -1896,8 +1898,10 @@ For any array, the result will always be larger than or equal to 2.\n\ Trailing singleton dimensions are not counted.\n\ @example\n\ +@group\n\ ndims (ones (4, 1, 2, 1)\n\ @result{} 3\n\ +@end group\n\ @end example\n\ @end deftypefn") { @@ -2775,7 +2779,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isreal (@var{x})\n\ Return true if @var{x} is a non-complex matrix or scalar.\n\ -For compatibility with Matlab, this includes logical and character\n\ +For compatibility with @sc{matlab}, this includes logical and character\n\ matrices.\n\ @end deftypefn") { @@ -2809,7 +2813,7 @@ DEFUN (isnumeric, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isnumeric (@var{x})\n\ -Return nonzero if @var{x} is a numeric object, i.e. an integer, real or complex array.\n\ +Return nonzero if @var{x} is a numeric object, i.e., an integer, real or complex array.\n\ Logical and character arrays are not considered to be numeric.\n\ @seealso{ischar, islogical, isinteger}\n\ @end deftypefn") @@ -4437,7 +4441,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} vec (@var{x})\n\ Return the vector obtained by stacking the columns of the matrix @var{x}\n\ -one above the other. Equivalent to @code{@var{x}(:)}. Useful for functional\n\ +one above the other. Equivalent to @code{@var{x}(:)}. Useful for functional\n\ programming.\n\ @end deftypefn") {
--- a/src/dirfns.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/dirfns.cc Wed Jun 16 20:36:55 2010 -0700 @@ -554,7 +554,7 @@ matches any string, including the null string,\n\ @itemx ?\n\ matches any single character, and\n\ -@item [...]\n\ +@item [@dots{}]\n\ matches any of the enclosed characters.\n\ @end table\n\ \n\ @@ -563,7 +563,6 @@ names. For example:\n\ \n\ @example\n\ -@group\n\ ls\n\ @result{}\n\ file1 file2 file3 myfile1 myfile1b \n\ @@ -584,7 +583,6 @@ [1,1] = file1\n\ [2,1] = file2\n\ @}\n\ -@end group\n\ @end example\n\ @seealso{dir, ls, stat, readdir, regexp}\n\ @end deftypefn")
--- a/src/graphics.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/graphics.cc Wed Jun 16 20:36:55 2010 -0700 @@ -4949,9 +4949,9 @@ \n\ In this case, the number of columns of @var{values} must match the number of\n\ elements in @var{properties}. The first column of @var{values} contains values\n\ -for the first entry in @var{properties} etc.. The number of rows of @var{values}\n\ -must be 1 or match the number of elements of @var{h}. In the first case, each\n\ -handle in @var{h} will be assigned the same values. In the latter case, the\n\ +for the first entry in @var{properties}, etc. The number of rows of @var{values}\n\ +must be 1 or match the number of elements of @var{h}. In the first case, each\n\ +handle in @var{h} will be assigned the same values. In the latter case, the\n\ first handle in @var{h} will be assigned the values from the first row of\n\ @var{values} and so on.\n\ @item as a structure array @var{pv}\n\
--- a/src/mappers.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/mappers.cc Wed Jun 16 20:36:55 2010 -0700 @@ -355,7 +355,7 @@ DEFUN (cbrt, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} cbrt (@var{x})\n\ -Return the real cube root of @var{x}. Unlike @code{@var{x}^(1/3)},\n\ +Return the real cube root of @var{x}. Unlike @code{@var{x}^(1/3)},\n\ the result will be negative if @var{x} is negative.\n\ @end deftypefn") { @@ -601,7 +601,7 @@ DEFUN (erfinv, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} erfinv (@var{x})\n\ -Computes the inverse error function, i.e. @var{y} such that\n\ +Computes the inverse error function, i.e., @var{y} such that\n\ @example\n\ erf(@var{y}) == @var{x}\n\ @end example\n\
--- a/src/ov-cell.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/ov-cell.cc Wed Jun 16 20:36:55 2010 -0700 @@ -1368,7 +1368,7 @@ Create a new cell array from the objects stored in the struct object.\n\ If @var{f} is the number of fields in the structure, the resulting\n\ cell array will have a dimension vector corresponding to\n\ -@code{[@var{F} size(@var{S})]}. For example:\n\ +@code{[@var{F} size(@var{S})]}. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/ov-range.cc Wed Jun 16 23:45:13 2010 +0200 +++ b/src/ov-range.cc Wed Jun 16 20:36:55 2010 -0700 @@ -612,9 +612,9 @@ @deftypefn {Built-in Function} {@var{val} =} allow_noninteger_range_as_index ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} allow_noninteger_range_as_index (@var{new_val})\n\ Query or set the internal variable that controls whether non-integer\n\ -ranges are allowed as indices. This might be useful for Matlab\n\ +ranges are allowed as indices. This might be useful for @sc{matlab}\n\ compatibility; however, it is still not entirely compatible because\n\ -Matlab treats the range expression differently in different contexts.\n\ +@sc{matlab} treats the range expression differently in different contexts.\n\ @end deftypefn") { return SET_INTERNAL_VARIABLE (allow_noninteger_range_as_index);