# HG changeset patch
# User Rik <octave@nomad.inbox5.com>
# Date 1329341491 28800
# Node ID b76f0740940ea5cfacaf4a60302f6524d1947f26
# Parent  a598273c9c3d8ab896a43f9fb20904f74121ae52
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.

diff -r a598273c9c3d -r b76f0740940e scripts/general/accumarray.m
--- a/scripts/general/accumarray.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/general/accumarray.m	Wed Feb 15 13:31:31 2012 -0800
@@ -92,7 +92,7 @@
 ## @end example
 ##
 ## The sparse option can be used as an alternative to the @code{sparse}
-## constructor (@pxref{doc-sparse}). Thus
+## constructor (@pxref{doc-sparse}).  Thus
 ##
 ## @example
 ## sparse (@var{i}, @var{j}, @var{sv})
@@ -106,7 +106,7 @@
 ## @end example
 ##
 ## @noindent
-## For repeated indices, @code{sparse} adds the corresponding value. To
+## For repeated indices, @code{sparse} adds the corresponding value.  To
 ## take the minimum instead, use @code{min} as an accumulator function:
 ##
 ## @example
diff -r a598273c9c3d -r b76f0740940e scripts/general/repmat.m
--- a/scripts/general/repmat.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/general/repmat.m	Wed Feb 15 13:31:31 2012 -0800
@@ -24,7 +24,7 @@
 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}])
 ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix
 ## @var{A} as each element.  If @var{n} is not specified, form an
-## @var{m} by @var{m} block matrix. For copying along more than two
+## @var{m} by @var{m} block matrix.  For copying along more than two
 ## dimensions, specify the number of times to copy across each dimension
 ## @var{m}, @var{n}, @var{p}, @dots{}, in a vector in the second argument.
 ## @seealso{repelems}
diff -r a598273c9c3d -r b76f0740940e scripts/image/imshow.m
--- a/scripts/image/imshow.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/image/imshow.m	Wed Feb 15 13:31:31 2012 -0800
@@ -41,6 +41,7 @@
 ##
 ## If given, the parameter @var{string_param1} has value
 ## @var{value1}.  @var{string_param1} can be any of the following:
+##
 ## @table @asis
 ## @item "displayrange"
 ## @var{value1} is the display range as described above.
diff -r a598273c9c3d -r b76f0740940e scripts/io/strread.m
--- a/scripts/io/strread.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/io/strread.m	Wed Feb 15 13:31:31 2012 -0800
@@ -102,6 +102,7 @@
 ## @item "commentstyle"
 ## Parts of @var{str} are considered comments and will be skipped.
 ## @var{value} is the comment style and can be any of the following.
+##
 ## @itemize
 ## @item "shell"
 ## Everything from @code{#} characters to the nearest end-of-line is skipped.
diff -r a598273c9c3d -r b76f0740940e scripts/miscellaneous/edit.m
--- a/scripts/miscellaneous/edit.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/miscellaneous/edit.m	Wed Feb 15 13:31:31 2012 -0800
@@ -74,6 +74,7 @@
 ## Octave's @env{EDITOR} built-in function, which comes from
 ## @code{getenv("EDITOR")} and defaults to @code{emacs}.  Use @code{%s}
 ## In place of the function name.  For example,
+##
 ## @table @samp
 ## @item [EDITOR, " %s"]
 ## Use the editor which Octave uses for @code{edit_history}.
@@ -110,6 +111,7 @@
 ## Be sure to use @code{<user@@host>} as your format.
 ##
 ## @item license
+##
 ## @table @samp
 ## @item gpl
 ## GNU General Public License (default).
diff -r a598273c9c3d -r b76f0740940e scripts/miscellaneous/mkoctfile.m
--- a/scripts/miscellaneous/mkoctfile.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/miscellaneous/mkoctfile.m	Wed Feb 15 13:31:31 2012 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Command} {} mkoctfile [-options] file @dots{}
+## @deftypefn  {Command} {} mkoctfile [-options] file @dots{}
 ## @deftypefnx {Function File} {[@var{output}, @var{status} =} mkoctfile (@dots{})
 ##
 ## The @code{mkoctfile} function compiles source code written in C,
diff -r a598273c9c3d -r b76f0740940e scripts/miscellaneous/warning_ids.m
--- a/scripts/miscellaneous/warning_ids.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/miscellaneous/warning_ids.m	Wed Feb 15 13:31:31 2012 -0800
@@ -18,6 +18,7 @@
 
 ## -*- texinfo -*-
 ## @cindex warning ids
+##
 ## @table @code
 ## @item Octave:abbreviated-property-match
 ## By default, the @code{Octave:abbreviated-property-match} warning is enabled.
diff -r a598273c9c3d -r b76f0740940e scripts/optimization/glpk.m
--- a/scripts/optimization/glpk.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/optimization/glpk.m	Wed Feb 15 13:31:31 2012 -0800
@@ -106,6 +106,7 @@
 ## An array of characters containing the sense of each constraint in the
 ## constraint matrix.  Each element of the array may be one of the
 ## following values
+##
 ## @table @asis
 ## @item "F"
 ## A free (unbounded) constraint (the constraint is ignored).
@@ -126,6 +127,7 @@
 ##
 ## @item vartype
 ## A column array containing the types of the variables.
+##
 ## @table @asis
 ## @item "C"
 ## A continuous variable.
@@ -149,6 +151,7 @@
 ## @table @code
 ## @item msglev (@w{@code{LPX_K_MSGLEV}}, default: 1)
 ## Level of messages output by solver routines:
+##
 ## @table @asis
 ## @item 0
 ## No output.
@@ -165,6 +168,7 @@
 ##
 ## @item scale (@w{@code{LPX_K_SCALE}}, default: 1)
 ## Scaling option:
+##
 ## @table @asis
 ## @item 0
 ## No scaling.
@@ -178,6 +182,7 @@
 ##
 ## @item dual    (@w{@code{LPX_K_DUAL}}, default: 0)
 ## Dual simplex option:
+##
 ## @table @asis
 ## @item 0
 ## Do not use the dual simplex.
@@ -188,6 +193,7 @@
 ##
 ## @item price   (@w{@code{LPX_K_PRICE}}, default: 1)
 ## Pricing option (for both primal and dual simplex):
+##
 ## @table @asis
 ## @item 0
 ## Textbook pricing.
@@ -198,6 +204,7 @@
 ##
 ## @item round   (@w{@code{LPX_K_ROUND}}, default: 0)
 ## Solution rounding option:
+##
 ## @table @asis
 ## @item 0
 ## Report all primal and dual values "as is".
@@ -219,6 +226,7 @@
 ##
 ## @item branch (@w{@code{LPX_K_BRANCH}}, default: 2)
 ## Branching heuristic option (for MIP only):
+##
 ## @table @asis
 ## @item 0
 ## Branch on the first variable.
@@ -232,6 +240,7 @@
 ##
 ## @item btrack (@w{@code{LPX_K_BTRACK}}, default: 2)
 ## Backtracking heuristic option (for MIP only):
+##
 ## @table @asis
 ## @item 0
 ## Depth first search.
@@ -250,6 +259,7 @@
 ## @item lpsolver (default: 1)
 ## Select which solver to use.  If the problem is a MIP problem this flag
 ## will be ignored.
+##
 ## @table @asis
 ## @item 1
 ## Revised simplex method.
@@ -339,6 +349,7 @@
 ## Status of the optimization.
 ##
 ## Simplex Method:
+##
 ## @table @asis
 ## @item 180 (@w{@code{LPX_OPT}})
 ## Solution is optimal.
@@ -359,6 +370,7 @@
 ## Solution status is undefined.
 ## @end table
 ## Interior Point Method:
+##
 ## @table @asis
 ## @item 150 (@w{@code{LPX_T_UNDEF}})
 ## The interior point method is undefined.
@@ -367,6 +379,7 @@
 ## The interior point method is optimal.
 ## @end table
 ## Mixed Integer Method:
+##
 ## @table @asis
 ## @item 170 (@w{@code{LPX_I_UNDEF}})
 ## The status is undefined.
@@ -421,6 +434,7 @@
 ##
 ## @item extra
 ## A data structure containing the following fields:
+##
 ## @table @code
 ## @item lambda
 ## Dual variables.
diff -r a598273c9c3d -r b76f0740940e scripts/optimization/lsqnonneg.m
--- a/scripts/optimization/lsqnonneg.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/optimization/lsqnonneg.m	Wed Feb 15 13:31:31 2012 -0800
@@ -31,6 +31,7 @@
 ## optional initial guess for @var{x}.
 ##
 ## Outputs:
+##
 ## @itemize @bullet
 ## @item resnorm
 ##
@@ -50,6 +51,7 @@
 ## @item output
 ##
 ## A structure with two fields:
+##
 ## @itemize @bullet
 ## @item "algorithm": The algorithm used ("nnls")
 ##
diff -r a598273c9c3d -r b76f0740940e scripts/optimization/optimset.m
--- a/scripts/optimization/optimset.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/optimization/optimset.m	Wed Feb 15 13:31:31 2012 -0800
@@ -25,6 +25,7 @@
 ## Create options struct for optimization functions.
 ##
 ## Valid parameters are:
+##
 ## @itemize @bullet
 ## @item AutoScaling
 ##
diff -r a598273c9c3d -r b76f0740940e scripts/optimization/pqpnonneg.m
--- a/scripts/optimization/pqpnonneg.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/optimization/pqpnonneg.m	Wed Feb 15 13:31:31 2012 -0800
@@ -30,6 +30,7 @@
 ## definite.  @var{x0} is an optional initial guess for @var{x}.
 ##
 ## Outputs:
+##
 ## @itemize @bullet
 ## @item minval
 ##
@@ -45,6 +46,7 @@
 ## @item output
 ##
 ## A structure with two fields:
+##
 ## @itemize @bullet
 ## @item "algorithm": The algorithm used ("nnls")
 ##
diff -r a598273c9c3d -r b76f0740940e scripts/plot/figure.m
--- a/scripts/plot/figure.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/plot/figure.m	Wed Feb 15 13:31:31 2012 -0800
@@ -17,8 +17,8 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {Function File} {} figure
-## @deftypefnx {Function File} {} figure @var{n}
+## @deftypefn  {Command} {} figure
+## @deftypefnx {Command} {} figure @var{n}
 ## @deftypefnx {Function File} {} figure (@var{n})
 ## @deftypefnx {Function File} {} figure (@var{n}, "@var{property}", @var{value}, @dots{})
 ## Set the current plot window to plot window @var{n}.  If no arguments are
diff -r a598273c9c3d -r b76f0740940e scripts/plot/print.m
--- a/scripts/plot/print.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/plot/print.m	Wed Feb 15 13:31:31 2012 -0800
@@ -64,6 +64,7 @@
 ##
 ## @item -d@var{device}
 ##   Output device, where @var{device} is one of:
+##
 ##   @table @code
 ##   @item ps
 ##   @itemx ps2
diff -r a598273c9c3d -r b76f0740940e scripts/plot/private/__print_parse_opts__.m
--- a/scripts/plot/private/__print_parse_opts__.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/plot/private/__print_parse_opts__.m	Wed Feb 15 13:31:31 2012 -0800
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{args} =} __print_parse_opts__ (@var{propname}, @var{propvalue})
+## @deftypefn  {Function File} {@var{args} =} __print_parse_opts__ (@var{propname}, @var{propvalue})
 ## @deftypefnx {Function File} {@var{args} =} __print_parse_opts__ (@var{struct})
 ## Undocumented internal function.
 ## @end deftypefn
diff -r a598273c9c3d -r b76f0740940e scripts/sparse/gmres.m
--- a/scripts/sparse/gmres.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/sparse/gmres.m	Wed Feb 15 13:31:31 2012 -0800
@@ -49,6 +49,7 @@
 ##
 ## @itemize @minus
 ## @item @var{flag} indicates the exit status:
+##
 ## @table @asis
 ## @item 0 : iteration converged to within the specified tolerance
 ##
diff -r a598273c9c3d -r b76f0740940e scripts/statistics/base/zscore.m
--- a/scripts/statistics/base/zscore.m	Wed Feb 15 12:48:22 2012 -0800
+++ b/scripts/statistics/base/zscore.m	Wed Feb 15 13:31:31 2012 -0800
@@ -21,13 +21,13 @@
 ## @deftypefnx {Function File} {[@var{z}, @var{mu}, @var{sigma}] =} zscore (@var{x}, @var{opt})
 ## @deftypefnx {Function File} {[@var{z}, @var{mu}, @var{sigma}] =} zscore (@var{x}, @var{opt}, @var{dim})
 ## If @var{x} is a vector, subtract its mean and divide by its standard
-## deviation. If the standard deviation is zero, divide by 1 instead.
+## deviation.  If the standard deviation is zero, divide by 1 instead.
 ## The optional parameter @var{opt} determines the normalization to use
 ## when computing the standard deviation and is the same as the
 ## corresponding parameter for @code{std}.
 ##
 ## If @var{x} is a matrix, do the above along the first non-singleton
-## dimension. If the third optional argument @var{dim} is given, operate
+## dimension.  If the third optional argument @var{dim} is given, operate
 ## along this dimension.
 ##
 ## The mean and standard deviation along @var{dim} are given in @var{mu}
diff -r a598273c9c3d -r b76f0740940e src/DLD-FUNCTIONS/__init_fltk__.cc
--- a/src/DLD-FUNCTIONS/__init_fltk__.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/DLD-FUNCTIONS/__init_fltk__.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -2055,6 +2055,7 @@
 @deftypefnx {Built-in Function} {} gui_mode (@var{mode})\n\
 Query or set the GUI mode for the current graphics toolkit.\n\
 The @var{mode} argument can be one of the following strings:\n\
+\n\
 @table @asis\n\
 @item '2d'\n\
 Allows panning and zooming of current axes.\n\
diff -r a598273c9c3d -r b76f0740940e src/DLD-FUNCTIONS/cellfun.cc
--- a/src/DLD-FUNCTIONS/cellfun.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/DLD-FUNCTIONS/cellfun.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -343,8 +343,8 @@
 @end group\n\
 @end example\n\
 \n\
-Given the parameter \"ErrorHandler\", then @var{errfunc} defines a function to\n\
-call in case @var{func} generates an error.  The form of the function is\n\
+Given the parameter \"ErrorHandler\", then @var{errfunc} defines a function\n\
+to call in case @var{func} generates an error.  The form of the function is\n\
 \n\
 @example\n\
 function [@dots{}] = errfunc (@var{s}, @dots{})\n\
diff -r a598273c9c3d -r b76f0740940e src/DLD-FUNCTIONS/nproc.cc
--- a/src/DLD-FUNCTIONS/nproc.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/DLD-FUNCTIONS/nproc.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -35,6 +35,7 @@
 \n\
 If called with the optional argument @var{query}, modify how processors\n\
 are counted as follows:\n\
+\n\
 @table @code\n\
 @item all\n\
 total number of processors.\n\
diff -r a598273c9c3d -r b76f0740940e src/DLD-FUNCTIONS/regexp.cc
--- a/src/DLD-FUNCTIONS/regexp.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/DLD-FUNCTIONS/regexp.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -457,6 +457,7 @@
 \n\
 @item * + ? @{@}\n\
 Repetition operators, representing\n\
+\n\
 @table @code\n\
 @item *\n\
 Match zero or more times\n\
diff -r a598273c9c3d -r b76f0740940e src/DLD-FUNCTIONS/spparms.cc
--- a/src/DLD-FUNCTIONS/spparms.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/DLD-FUNCTIONS/spparms.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -97,9 +97,9 @@
 The value of individual keys can be set with\n\
 @code{spparms (@var{key}, @var{val})}.\n\
 The default values can be restored with the special keyword\n\
-\"defaults\".  The special keyword \"tight\" can be used to set the mmd solvers\n\
-to attempt a sparser solution at the potential cost of longer running\n\
-time.\n\
+\"defaults\".  The special keyword \"tight\" can be used to set the mmd\n\
+solvers to attempt a sparser solution at the potential cost of longer\n\
+running time.\n\
 @end deftypefn")
 {
   octave_value_list retval;
diff -r a598273c9c3d -r b76f0740940e src/dirfns.cc
--- a/src/dirfns.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/dirfns.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -554,6 +554,7 @@
 them, or an empty cell array if no patterns match.  The pattern strings are\n\
 interpreted as filename globbing patterns (as they are used by Unix shells).\n\
 Within a pattern\n\
+\n\
 @table @code\n\
 @itemx *\n\
 matches any string, including the null string,\n\
diff -r a598273c9c3d -r b76f0740940e src/file-io.cc
--- a/src/file-io.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/file-io.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -1072,7 +1072,7 @@
 DEFUN (fscanf, args, ,
   "-*- texinfo -*-\n\
 @deftypefn  {Built-in Function} {[@var{val}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\
-+@deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} fscanf (@var{fid}, @var{template}, @var{locale})\n\
+@deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} fscanf (@var{fid}, @var{template}, @var{locale})\n\
 In the first form, read from @var{fid} according to @var{template},\n\
 returning the result in the matrix @var{val}.\n\
 \n\
@@ -1111,9 +1111,9 @@
 with each conversion specifier in @var{template} corresponding to a\n\
 single scalar return value.  This form is more `C-like', and also\n\
 compatible with previous versions of Octave.  The number of successful\n\
-conversions is returned in @var{count}. It permits to explicitly\n\
+conversions is returned in @var{count}.  It permits to explicitly\n\
 specify a locale to take into account language specific features, \n\
-such as decimal separator. This operation restores the previous locales\n\
+such as decimal separator.  This operation restores the previous locales\n\
 setting at the end of the conversion.\n\
 @ifclear OCTAVE_MANUAL\n\
 \n\
@@ -2227,6 +2227,7 @@
 @deftypefnx {Built-in Function} {} SEEK_END ()\n\
 Return the numerical value to pass to @code{fseek} to perform\n\
 one of the following actions:\n\
+\n\
 @table @code\n\
 @item SEEK_SET\n\
 Position file relative to the beginning.\n\
diff -r a598273c9c3d -r b76f0740940e src/load-save.cc
--- a/src/load-save.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/load-save.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -1532,6 +1532,7 @@
 \n\
 The list of variables to save may use wildcard patterns containing\n\
 the following special characters:\n\
+\n\
 @table @code\n\
 @item ?\n\
 Match any single character.\n\
diff -r a598273c9c3d -r b76f0740940e src/ov-null-mat.cc
--- a/src/ov-null-mat.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/ov-null-mat.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -96,6 +96,7 @@
 delete array elements.  This function should be used when overloading\n\
 indexed assignment for user-defined classes instead of @code{isempty}, to\n\
 distinguish the cases:\n\
+\n\
 @table @asis\n\
 @item @code{A(I) = []}\n\
 This should delete elements if @code{I} is nonempty.\n\
diff -r a598273c9c3d -r b76f0740940e src/ov-usr-fcn.cc
--- a/src/ov-usr-fcn.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/ov-usr-fcn.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -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\
diff -r a598273c9c3d -r b76f0740940e src/variables.cc
--- a/src/variables.cc	Wed Feb 15 12:48:22 2012 -0800
+++ b/src/variables.cc	Wed Feb 15 13:31:31 2012 -0800
@@ -1798,6 +1798,7 @@
 @table @asis\n\
 @item Attr\n\
 Attributes of the listed variable.  Possible attributes are:\n\
+\n\
 @table @asis\n\
 @item blank\n\
 Variable in local scope\n\
@@ -2298,6 +2299,7 @@
 clear the function definition.\n\
 \n\
 The following options are available in both long and short form\n\
+\n\
 @table @code\n\
 @item -all, -a\n\
 Clears all local and global user-defined variables and all functions\n\