changeset 19439:cbce5d1bcaf9

doc: Periodic grammarcheck of documentation.
author Rik <rik@octave.org>
date Tue, 16 Dec 2014 15:36:27 -0800
parents c2f4f6eb5907
children e723e93ca2a0
files doc/interpreter/plot.txi libinterp/corefcn/debug.cc libinterp/corefcn/pr-output.cc libinterp/dldfcn/symrcm.cc scripts/general/flip.m scripts/general/flipdim.m scripts/miscellaneous/gzip.m scripts/miscellaneous/license.m scripts/miscellaneous/open.m scripts/miscellaneous/perl.m scripts/miscellaneous/python.m scripts/miscellaneous/recycle.m scripts/miscellaneous/what.m scripts/sparse/ichol.m
diffstat 14 files changed, 33 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/plot.txi	Tue Dec 16 12:07:32 2014 -0800
+++ b/doc/interpreter/plot.txi	Tue Dec 16 15:36:27 2014 -0800
@@ -1343,13 +1343,13 @@
 
 In this Section the graphics object properties are discussed in detail, starting
 with the root figure properties and continuing through the objects
-hierarchy. The documentation about a specific graphics object can be displayed 
-using @code{doc} function, e.g. @code{doc ("axes properties")} will show 
+hierarchy.  The documentation about a specific graphics object can be displayed 
+using @code{doc} function, e.g., @code{doc ("axes properties")} will show 
 @ref{Axes Properties}. 
 
 The allowed values for radio (string) properties can be retrieved 
 programmatically or displayed using the one or 
-two arguments call to @code{set} function. @xref{XREFset, , set}.
+two arguments call to @code{set} function.  @xref{XREFset, , set}.
 
 In the following documentation, default values are enclosed in @{ @}.
 
@@ -1568,9 +1568,11 @@
 
 @c Special handling required to avoid '--' becoming single en-dash in Info
 @ifnottex
+
 @item @verb{|"--"|}
 @end ifnottex
 @iftex
+
 @item @code{"--"}
 @end iftex
 Dashed line.
--- a/libinterp/corefcn/debug.cc	Tue Dec 16 12:07:32 2014 -0800
+++ b/libinterp/corefcn/debug.cc	Tue Dec 16 15:36:27 2014 -0800
@@ -1549,7 +1549,7 @@
 
 DEFUN (db_next_breakpoint_quiet, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} db_next_breakpoint_quiet ()\n\
+@deftypefn  {Built-in Function} {} db_next_breakpoint_quiet ()\n\
 @deftypefnx {Built-in Function} {} db_next_breakpoint_quiet (@var{flag})\n\
 Disable line info printing at the next breakpoint.  With a logical\n\
 argument, set the state on or off.\n\
--- a/libinterp/corefcn/pr-output.cc	Tue Dec 16 12:07:32 2014 -0800
+++ b/libinterp/corefcn/pr-output.cc	Tue Dec 16 15:36:27 2014 -0800
@@ -3989,8 +3989,8 @@
 \n\
 The optional argument @var{chars} specifies a list of 3 characters to use\n\
 for printing values greater than zero, less than zero and equal to zero.\n\
-For example, with the @samp{\"+\" \"+-.\"} format, @code{[1, 0, -1; -1, 0, 1]}\n\
-is displayed as\n\
+For example, with the @samp{\"+\" \"+-.\"} format,\n\
+@code{[1, 0, -1; -1, 0, 1]} is displayed as\n\
 \n\
 @example\n\
 @group\n\
--- a/libinterp/dldfcn/symrcm.cc	Tue Dec 16 12:07:32 2014 -0800
+++ b/libinterp/dldfcn/symrcm.cc	Tue Dec 16 15:36:27 2014 -0800
@@ -426,8 +426,8 @@
 descriptions found in\n\
 \n\
 @nospell{E. Cuthill, J. McKee}. @cite{Reducing the Bandwidth of Sparse\n\
-Symmetric Matrices}. Proceedings of the 24th ACM National Conference, 157--172\n\
-1969, Brandon Press, New Jersey.\n\
+Symmetric Matrices}. Proceedings of the 24th ACM National Conference,\n\
+157--172 1969, Brandon Press, New Jersey.\n\
 \n\
 @nospell{A. George, J.W.H. Liu}. @cite{Computer Solution of Large Sparse\n\
 Positive Definite Systems}, Prentice Hall Series in Computational\n\
--- a/scripts/general/flip.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/general/flip.m	Tue Dec 16 15:36:27 2014 -0800
@@ -30,23 +30,17 @@
 ## @group
 ## flip ([1  2  3  4])
 ##       @result{}  4  3  2  1
-## @end group
 ##
-## @group
 ## flip ([1; 2; 3; 4])
 ##       @result{}  4
 ##           3
 ##           2
 ##           1
-## @end group
 ##
-## @group
 ## flip ([1 2; 3 4])
 ##       @result{}  3  4
 ##           1  2
-## @end group
 ##
-## @group
 ## flip ([1 2; 3 4], 2)
 ##       @result{}  2  1
 ##           4  3
--- a/scripts/general/flipdim.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/general/flipdim.m	Tue Dec 16 15:36:27 2014 -0800
@@ -23,7 +23,7 @@
 ## Flip array across specific dimension.
 ##
 ## This function is an alias for @code{flip} and exists for backwards
-## and @sc{Matlab} compatibility.  See further details about its usage
+## and @sc{matlab} compatibility.  See further details about its usage
 ## on @code{flip} help text.
 ##
 ## @seealso{flip, fliplr, flipud, rot90, rotdim}
--- a/scripts/miscellaneous/gzip.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/gzip.m	Tue Dec 16 15:36:27 2014 -0800
@@ -25,7 +25,7 @@
 ## wildcards in the filename such as @samp{*} or @samp{?} are accepted and
 ## expanded.  Each file is compressed separately and a new file with a
 ## @file{".gz"} extension is created.  The original files are not modified,
-## but existing compressed files will be silently overwritten. If a directory
+## but existing compressed files will be silently overwritten.  If a directory
 ## is specified then @code{gzip} recursively compresses all files in the
 ## directory.
 ##
--- a/scripts/miscellaneous/license.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/license.m	Tue Dec 16 15:36:27 2014 -0800
@@ -30,7 +30,7 @@
 ##
 ## GNU Octave is free software distributed under the GNU General Public
 ## License (GPL), and a license manager makes no sense.  This function is
-## provided only for @sc{Matlab} compatibility.
+## provided only for @sc{matlab} compatibility.
 ##
 ## When called with no extra input arguments, it returns the Octave license,
 ## otherwise the first input defines the operation mode and must be one of
--- a/scripts/miscellaneous/open.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/open.m	Tue Dec 16 15:36:27 2014 -0800
@@ -18,7 +18,7 @@
 
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {@var{output} =} open @var{file}
-## @deftypefnx  {Function File} {@var{output} =} open (@var{file})
+## @deftypefnx {Function File} {@var{output} =} open (@var{file})
 ## Open the file @var{file} in Octave or in an external application
 ## based on the file type as determined by the file name extension.
 ##
@@ -27,8 +27,10 @@
 ## @table @code
 ## @item .m
 ## Open file in the editor.
+##
 ## @item .mat
 ## Load the file in the base workspace.
+##
 ## @item .exe
 ## Execute the program (on Windows systems only).
 ## @end table
--- a/scripts/miscellaneous/perl.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/perl.m	Tue Dec 16 15:36:27 2014 -0800
@@ -24,7 +24,7 @@
 ## arguments.
 ##
 ## Return output in @var{output} and optional status in @var{status}.  If
-## @var{scriptfile} is not an absolute file name it is is searched for in the
+## @var{scriptfile} is not an absolute file name it is searched for in the
 ## current directory and then in the Octave loadpath.
 ## @seealso{system, python}
 ## @end deftypefn
--- a/scripts/miscellaneous/python.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/python.m	Tue Dec 16 15:36:27 2014 -0800
@@ -25,7 +25,7 @@
 ## arguments.
 ##
 ## Return output in @var{output} and optional status in @var{status}.  If
-## @var{scriptfile} is not an absolute file name it is is searched for in the
+## @var{scriptfile} is not an absolute file name it is searched for in the
 ## current directory and then in the Octave loadpath.
 ## @seealso{system, perl}
 ## @end deftypefn
--- a/scripts/miscellaneous/recycle.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/recycle.m	Tue Dec 16 15:36:27 2014 -0800
@@ -25,9 +25,10 @@
 ## instead move them to a temporary location (such as the directory labeled
 ## Trash).
 ##
-## Programming Note: This function is provided for Matlab compatibility, but
-## recycling is not implemented in Octave.  To help avoid accidental data loss
-## an error will be raised if an attempt is made to enable file recycling.
+## Programming Note: This function is provided for @sc{matlab} compatibility,
+## but recycling is not implemented in Octave.  To help avoid accidental data
+## loss an error will be raised if an attempt is made to enable file
+## recycling.
 ## @seealso{delete, rmdir}
 ## @end deftypefn
 
--- a/scripts/miscellaneous/what.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/miscellaneous/what.m	Tue Dec 16 15:36:27 2014 -0800
@@ -30,22 +30,31 @@
 ## @table @asis
 ## @item path
 ## Full path to directory @var{dir}
+##
 ## @item m
 ## Cell array of m-files
+##
 ## @item mat
 ## Cell array of mat files
+##
 ## @item mex
 ## Cell array of mex files
+##
 ## @item oct
 ## Cell array of oct files
+##
 ## @item mdl
 ## Cell array of mdl files
+##
 ## @item slx
 ## Cell array of slx files
+##
 ## @item p
 ## Cell array of p-files
+##
 ## @item classes
 ## Cell array of class directories (@file{@@@var{classname}/})
+##
 ## @item packages
 ## Cell array of package directories (@file{+@var{pkgname}/})
 ## @end table
--- a/scripts/sparse/ichol.m	Tue Dec 16 12:07:32 2014 -0800
+++ b/scripts/sparse/ichol.m	Tue Dec 16 15:36:27 2014 -0800
@@ -56,8 +56,8 @@
 ##
 ## @item droptol
 ## A non-negative scalar specifying the drop tolerance for factorization if
-## performing @nospell{ICT}@.  The default value is 0 which produces the complete
-## Cholesky factorization.
+## performing @nospell{ICT}@.  The default value is 0 which produces the
+## complete Cholesky factorization.
 ##
 ## Non-diagonal entries of @var{L} are set to 0 unless
 ##