# HG changeset patch
# User Rik <rik@octave.org>
# Date 1453353287 28800
# Node ID dba88797f69fd0ee5103161213f78671292a6d71
# Parent  f5b17eb2508bb73d7ac004b8d58a1340bf1ea082
doc: Periodic grammarcheck of documentation.

diff -r f5b17eb2508b -r dba88797f69f doc/interpreter/arith.txi
--- a/doc/interpreter/arith.txi	Wed Jan 20 20:57:45 2016 -0800
+++ b/doc/interpreter/arith.txi	Wed Jan 20 21:14:47 2016 -0800
@@ -112,7 +112,11 @@
 @code{pi/180}
 @end ifnottex
 or use the @code{deg2rad} function.  For example, @code{sin (30 * pi/180)}
-returns the sine of 30 degrees.  As an alternative, Octave provides a number of trigonometric functions which work directly on an argument specified in degrees.  These functions are named after the base trigonometric function with a @samp{d} suffix.  As an example, @code{sin} expects an angle in radians while @code{sind} expects an angle in degrees.
+returns the sine of 30 degrees.  As an alternative, Octave provides a number of
+trigonometric functions which work directly on an argument specified in
+degrees.  These functions are named after the base trigonometric function with
+a @samp{d} suffix.  As an example, @code{sin} expects an angle in radians while
+@code{sind} expects an angle in degrees.
 
 Octave uses the C library trigonometric functions.  It is expected that these
 functions are defined by the ISO/IEC 9899 Standard.  This Standard is available
diff -r f5b17eb2508b -r dba88797f69f doc/interpreter/diffeq.txi
--- a/doc/interpreter/diffeq.txi	Wed Jan 20 20:57:45 2016 -0800
+++ b/doc/interpreter/diffeq.txi	Wed Jan 20 21:14:47 2016 -0800
@@ -143,10 +143,11 @@
     method.  This is a fourth--order accurate integrator therefore the local
     error normally expected is @math{O(h^5)}.  This solver requires six
     function evaluations per integration step.
+
     @item @code{ode23} Integrates a system of non--stiff ordinary differential equations
     (non-stiff ODEs and DAEs) using second order @nospell{Bogacki-Shampine}
-    method. This is a second-order accurate integrator therefore the local
-    error normally expected is @math{O(h^3)}. This solver requires three
+    method.  This is a second-order accurate integrator therefore the local
+    error normally expected is @math{O(h^3)}.  This solver requires three
     function evaluations per integration step.
   @end itemize
 @end itemize
diff -r f5b17eb2508b -r dba88797f69f doc/interpreter/plot.txi
--- a/doc/interpreter/plot.txi	Wed Jan 20 20:57:45 2016 -0800
+++ b/doc/interpreter/plot.txi	Wed Jan 20 21:14:47 2016 -0800
@@ -949,7 +949,7 @@
 use of @LaTeX{} commands.
 
 A complete example showing the capabilities of text printing using the
-@code{-dpdflatexstandalone} option is:
+@option{-dpdflatexstandalone} option is:
 
 @example
 @group
@@ -978,7 +978,7 @@
 
 @float Figure,fig:extendedtext
 @center @image{extended,4in}
-@caption{Example of inclusion of text with use of @code{-dpdflatexstandalone}}
+@caption{Example of inclusion of text with use of @option{-dpdflatexstandalone}}
 @end float
 @end ifnotinfo
 
diff -r f5b17eb2508b -r dba88797f69f doc/interpreter/stmt.txi
--- a/doc/interpreter/stmt.txi	Wed Jan 20 20:57:45 2016 -0800
+++ b/doc/interpreter/stmt.txi	Wed Jan 20 21:14:47 2016 -0800
@@ -596,7 +596,7 @@
 @noindent
 In the above case, the multi-dimensional matrix @var{c} is reshaped to a
 two-dimensional matrix as @code{reshape (c, rows (c), prod (size (c)(2:end)))}
-and then the same behavior as a loop over a two dimensional matrix is produced.
+and then the same behavior as a loop over a two-dimensional matrix is produced.
 
 Although it is possible to rewrite all @code{for} loops as @code{while}
 loops, the Octave language has both statements because often a
diff -r f5b17eb2508b -r dba88797f69f libinterp/corefcn/hash.cc
--- a/libinterp/corefcn/hash.cc	Wed Jan 20 20:57:45 2016 -0800
+++ b/libinterp/corefcn/hash.cc	Wed Jan 20 21:14:47 2016 -0800
@@ -52,7 +52,7 @@
 
 DEFUN (hash, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {} {} hash (@var{hfun},@var{str})\n\
+@deftypefn {} {} hash (@var{hfun}, @var{str})\n\
 Calculate the hash value of the string @var{str} using the hash function\n\
 @var{hfun}.\n\
 \n\
@@ -84,7 +84,7 @@
 Secure Hash Algorithm 2 (512 Bits, RFC 6234)\n\
 @end table\n\
 \n\
-To calculate for example the MD5 hash value of the string @code{\"abc\"}\n\
+To calculate for example the MD5 hash value of the string @qcode{\"abc\"}\n\
 the @code{hash} function is called as follows:\n\
 \n\
 @example\n\
@@ -103,7 +103,7 @@
 @end group\n\
 @end example\n\
 \n\
-And to compute the hash value of a file, e.g. @code{file = \"file.txt\"},\n\
+And to compute the hash value of a file, e.g., @code{file = \"file.txt\"},\n\
 call @code{hash} in combination with the @code{fileread}:\n\
 \n\
 @example\n\
diff -r f5b17eb2508b -r dba88797f69f scripts/deprecated/md5sum.m
--- a/scripts/deprecated/md5sum.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/deprecated/md5sum.m	Wed Jan 20 21:14:47 2016 -0800
@@ -39,7 +39,7 @@
 ## If the second parameter @var{opt} exists and is true, then calculate the MD5
 ## sum of the string @var{str}.
 ##
-## @seealso{hash,fileread}
+## @seealso{hash, fileread}
 ## @end deftypefn
 
 function r = md5sum (str, opt)
diff -r f5b17eb2508b -r dba88797f69f scripts/general/display.m
--- a/scripts/general/display.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/general/display.m	Wed Jan 20 21:14:47 2016 -0800
@@ -22,7 +22,7 @@
 ##
 ## The Octave interpreter calls the @code{display} function whenever it needs
 ## to present a class on-screen.  Typically, this would be a statement which
-## does not end in a semicolon to suppress output.  For example,
+## does not end in a semicolon to suppress output.  For example:
 ##
 ## @example
 ## myobj = myclass (@dots{})
@@ -33,8 +33,10 @@
 ## report only that the object is an instance of its class.
 ##
 ## @example
+## @group
 ## myobj = myclass (@dots{})
 ##   @result{} myobj = <class myclass>
+## @end group
 ## @end example
 ##
 ## @seealso{class, subsref, subsasgn}
diff -r f5b17eb2508b -r dba88797f69f scripts/image/im2double.m
--- a/scripts/image/im2double.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/image/im2double.m	Wed Jan 20 21:14:47 2016 -0800
@@ -43,7 +43,7 @@
 ##
 ## If @var{img} is an indexed image, then the second argument should be
 ## the string @qcode{"indexed"}.  If so, then @var{img} must either be
-## of floating point class, or unsigned integer class  and it will simply
+## of floating point class, or unsigned integer class and it will simply
 ## be cast to double.  If it is an integer class, a +1 offset is applied.
 ##
 ## @seealso{double}
diff -r f5b17eb2508b -r dba88797f69f scripts/ode/odeplot.m
--- a/scripts/ode/odeplot.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/ode/odeplot.m	Wed Jan 20 21:14:47 2016 -0800
@@ -21,28 +21,46 @@
 ## -*- texinfo -*-
 ## @deftypefn {} {[@var{ret}] =} odeplot (@var{t}, @var{y}, @var{flag})
 ##
-## Open a new figure window and plot the results from the variable @var{y} of type column vector over time while solving. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is
+## Open a new figure window and plot the results from the variable @var{y} of
+## type column vector over time while solving.  The types and the values of
+## the input parameter @var{t} and the output parameter @var{ret} depend on
+## the input value @var{flag} that is of type string.  If @var{flag} is
+##
 ## @table @option
-## @item  @code{"init"}
-## then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function,
-## @item  @code{""}
-## then @var{t} must be a double scalar specifying the actual time step and the return value is false (resp. value 0) for 'not stop solving',
-## @item  @code{"done"}
-## then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function.
+## @item  @qcode{"init"}
+## then @var{t} must be a double column vector of length 2 with the first and
+## the last time step and nothing is returned from this function,
+##
+## @item  @qcode{""}
+## then @var{t} must be a double scalar specifying the actual time step and
+## the return value is false (resp. value 0) for @qcode{"not stop solving"},
+##
+## @item  @qcode{"done"}
+## then @var{t} must be a double scalar specifying the last time step and
+## nothing is returned from this function.
 ## @end table
 ##
-## This function is called by a ode solver function if it was specified in an options structure with the @command{odeset}. This function is an internal helper function therefore it should never be necessary that this function is called directly by a user. There is only little error detection implemented in this function file to achieve the highest performance.
+## This function is called by an ode solver function if it was specified in
+## an options structure with the @command{odeset}.  This function is an
+## internal helper function therefore it should never be necessary that this
+## function is called directly by a user.  There is only little error
+## detection implemented in this function file to achieve the highest
+## performance.
 ##
-## For example, solve an anonymous implementation of the "Van der Pol" equation and display the results while solving
+## For example, solve an anonymous implementation of the
+## @qcode{"Van der Pol"} equation and display the results while solving
+##
 ## @example
+## @group
 ## fvdb = @@(t,y) [y(2); (1 - y(1)^2) * y(2) - y(1)];
 ##
 ## opt = odeset ("OutputFcn", @@odeplot, "RelTol", 1e-6);
 ## sol = ode45 (fvdb, [0 20], [2 0], opt);
+## @end group
 ## @end example
 ## @end deftypefn
 ##
-## @seealso{odeset,odeget}
+## @seealso{odeset, odeget}
 
 function ret = odeplot (t, y, flag, varargin)
 
diff -r f5b17eb2508b -r dba88797f69f scripts/ode/private/known_option_names.m
--- a/scripts/ode/private/known_option_names.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/ode/private/known_option_names.m	Wed Jan 20 21:14:47 2016 -0800
@@ -17,9 +17,9 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {} {@var{val} =} known_option_names ()
+## @deftypefn {} {@var{val} =} known_option_names ()
 ## Return a list of known names for ode options.
-## @seealso{odeset,odeget}
+## @seealso{odeset, odeget}
 ## @end deftypefn
 
 function ret = known_option_names ()
diff -r f5b17eb2508b -r dba88797f69f scripts/ode/private/runge_kutta_23.m
--- a/scripts/ode/private/runge_kutta_23.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/ode/private/runge_kutta_23.m	Wed Jan 20 21:14:47 2016 -0800
@@ -27,7 +27,7 @@
 ##
 ## This function can be used to integrate a system of ODEs with a given initial
 ## condition @var{x} from @var{t} to @var{t+dt}, with the Bogacki-Shampine
-## method of third order. For the definition of this method see
+## method of third order.  For the definition of this method see
 ## @url{http://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods}.
 ##
 ## @var{@fun} is a function handle that defines the ODE: @code{y' = f(tau,y)}.
@@ -41,7 +41,7 @@
 ## @var{dt} is the timestep, that is the length of the integration interval.
 ##
 ## The optional fourth argument @var{options} specifies options for the ODE
-## solver. It is a structure generated by @code{odeset}. In particular it
+## solver.  It is a structure generated by @code{odeset}.  In particular it
 ## contains the field @var{funarguments} with the optional arguments to be used
 ## in the evaluation of @var{fun}.
 ##
@@ -49,7 +49,7 @@
 ## evaluations of the previous step to use in a FSAL scheme.
 ##
 ## The optional sixth argument @var{t_next} (@code{t_next = t + dt}) specifies
-## the end of the integration interval. The output @var{x_next} s the higher
+## the end of the integration interval.  The output @var{x_next} s the higher
 ## order computed solution at time @var{t_next} (local extrapolation is
 ## performed).
 ##
diff -r f5b17eb2508b -r dba88797f69f scripts/plot/util/print.m
--- a/scripts/plot/util/print.m	Wed Jan 20 20:57:45 2016 -0800
+++ b/scripts/plot/util/print.m	Wed Jan 20 21:14:47 2016 -0800
@@ -125,7 +125,7 @@
 ## braces).  The @samp{pdflatex} device, and any of the @samp{standalone}
 ## formats, are not available with the Gnuplot toolkit.
 ##
-##   @item epscairo
+##   @item  epscairo
 ##   @itemx pdfcairo
 ##   @itemx epscairolatex
 ##   @itemx pdfcairolatex
@@ -133,7 +133,7 @@
 ##   @itemx pdfcairolatexstandalone
 ##     Generate Cairo based output when using the Gnuplot graphics toolkit.
 ## The @samp{epscairo} and @samp{pdfcairo} devices are synonymous with
-## the @samp{epsc} device. The @LaTeX{} variants generate a @LaTeX{} file,
+## the @samp{epsc} device.  The @LaTeX{} variants generate a @LaTeX{} file,
 ## @file{@var{filename}.tex}, for the text portions of a plot, and an image
 ## file, @file{@var{filename}.(eps|pdf)}, for the graph portion of the plot.
 ## The @samp{standalone} variants behave as described for
@@ -192,10 +192,10 @@
 ##   @item svg
 ##     Scalable vector graphics
 ##
-##   @item tikz
+##   @item  tikz
 ##   @itemx tikzstandalone
 ##     Generate a @LaTeX{} file using PGF/TikZ@.  For the FLTK toolkit
-## the result is PGF. The @samp{tikzstandalone} device produces a @LaTeX{}
+## the result is PGF@.  The @samp{tikzstandalone} device produces a @LaTeX{}
 ## document which includes the TikZ file (@samp{tikzstandalone} is only
 ## available for the Gnuplot graphics toolkit).
 ##