# HG changeset patch
# User Rik <rdrider0-list@yahoo.com>
# Date 1237752855 25200
# Node ID 51dc9691f23f11f6fd9f62cac074bd267cff812b
# Parent  fca0dc2fb0420e214dbbfd836abf3daf4e9fc378
Cleanup documentation files errors.texi, debug.texi, io.texi

Spellcheck
Stylecheck

diff -r fca0dc2fb042 -r 51dc9691f23f doc/interpreter/debug.txi
--- a/doc/interpreter/debug.txi	Sun Mar 22 11:15:35 2009 -0700
+++ b/doc/interpreter/debug.txi	Sun Mar 22 13:14:15 2009 -0700
@@ -20,8 +20,8 @@
 @chapter Debugging
 
 Octave includes a built-in debugger to aid in the development of
-scripts. This can be used to interrupt the execution of an Octave script
-at a certain point, or when certain conditions are met. Once execution
+scripts.  This can be used to interrupt the execution of an Octave script
+at a certain point, or when certain conditions are met.  Once execution
 has stopped, and debug mode is entered, the symbol table at the point
 where execution has stopped can be examined and modified to check for
 errors.
@@ -41,7 +41,7 @@
 @section Entering Debug Mode
 
 There are two basic means of interrupting the execution of an Octave
-script. These are breakpoints @pxref{Breakpoints}, discussed in the next
+script.  These are breakpoints @pxref{Breakpoints}, discussed in the next
 section and interruption based on some condition.
 
 Octave supports three means to stop execution based on the values set in
@@ -80,11 +80,11 @@
 
 @noindent
 Note that breakpoints cannot be set in built-in functions
-(eg. @code{sin}, etc) or dynamically loaded function (ie. oct-files). To
+(e.g., @code{sin}, etc) or dynamically loaded function (i.e., oct-files).  To
 set a breakpoint immediately on entering a function, the breakpoint
 should be set to line 1. The leading comment block will be ignored and
 the breakpoint will be set to the first executable statement in the
-function. For example
+function.  For example
 
 @example
 @group
@@ -113,7 +113,7 @@
 dbclear ("asind", dbstatus ("asind"));
 @end example
 
-A breakpoint can be set in a subfunction. For example if a file contains
+A breakpoint can be set in a subfunction.  For example if a file contains
 the functions
 
 @example
@@ -146,7 +146,7 @@
 
 @noindent
 The @code{keyboard} function is typically placed in a script at the
-point where the user desires that the execution is stopped. It
+point where the user desires that the execution is stopped.  It
 automatically sets the running script into the debug mode.
 
 @node Debug Mode
diff -r fca0dc2fb042 -r 51dc9691f23f doc/interpreter/errors.txi
--- a/doc/interpreter/errors.txi	Sun Mar 22 11:15:35 2009 -0700
+++ b/doc/interpreter/errors.txi	Sun Mar 22 13:14:15 2009 -0700
@@ -105,7 +105,7 @@
 Invalid call to f.  Correct usage is:
 
      @print{}  -- Function File: f (ARG1)
-     @print{}      Function help text goes here...
+     @print{}      Function help text goes here@dots{}
      @print{} 
      @print{} 
      @print{} 
@@ -191,7 +191,7 @@
 
 @DOCSTRING(rethrow)
 
-@c XXX: I have no idea what the rest of the functions are used for...
+@c FIXME: I have no idea what the rest of the functions are used for...
 
 @DOCSTRING(errno)
 
@@ -221,18 +221,18 @@
 @subsection Issuing Warnings
 
 It is possible to issue warnings from any code using the @code{warning}
-function. In its most simple form, the @code{warning} function takes a
-string describing the warning as its input argument. As an example,
+function.  In its most simple form, the @code{warning} function takes a
+string describing the warning as its input argument.  As an example,
 the following code controls if the variable @samp{a} is non-negative,
 and if not issues a warning and sets @samp{a} to zero.
 
 @example
 a = -1;
 if (a < 0)
-  warning ("'a' must be non-negative. Setting 'a' to zero.");
+  warning ("'a' must be non-negative.  Setting 'a' to zero.");
   a = 0;
 endif
-     @print{} 'a' must be non-negative. Setting 'a' to zero.
+     @print{} 'a' must be non-negative.  Setting 'a' to zero.
 @end example
 
 Since warnings aren't fatal to a running program, it is not possible
@@ -263,7 +263,7 @@
 
 @example
 warning ("non-negative-variable", 
-         "'a' must be non-negative. Setting 'a' to zero.");
+         "'a' must be non-negative.  Setting 'a' to zero.");
 @end example
 
 @noindent
@@ -272,7 +272,7 @@
 @example
 warning ("off", "non-negative-variable");
 warning ("non-negative-variable", 
-         "'a' must be non-negative. Setting 'a' to zero.");
+         "'a' must be non-negative.  Setting 'a' to zero.");
 @end example
 
 The functions distributed with Octave can issue one of the following
diff -r fca0dc2fb042 -r 51dc9691f23f doc/interpreter/io.txi
--- a/doc/interpreter/io.txi	Sun Mar 22 11:15:35 2009 -0700
+++ b/doc/interpreter/io.txi	Sun Mar 22 13:14:15 2009 -0700
@@ -221,7 +221,7 @@
 If Octave for some reason exits unexpectedly it will by default save the
 variables available in the workspace to a file in the current directory.
 By default this file is named @samp{octave-core} and can be loaded
-into memory with the @code{load} command.  While the default behaviour
+into memory with the @code{load} command.  While the default behavior
 most often is reasonable it can be changed through the following
 functions.
 
@@ -302,7 +302,7 @@
 @example
 filename = "myfile.txt";
 fid = fopen (filename, "w");
-# Do the actual I/O here...
+# Do the actual I/O here@dots{}
 fclose (fid);
 @end example
 
diff -r fca0dc2fb042 -r 51dc9691f23f scripts/general/rat.m
--- a/scripts/general/rat.m	Sun Mar 22 11:15:35 2009 -0700
+++ b/scripts/general/rat.m	Sun Mar 22 13:14:15 2009 -0700
@@ -20,8 +20,8 @@
 ## @deftypefn {Function File} {@var{s} =} rat (@var{x}, @var{tol})
 ## @deftypefnx {Function File} {[@var{n}, @var{d}] =} rat (@var{x}, @var{tol})
 ##
-## Find a rational approximation to @var{x} within tolerance defined
-## by @var{tol} using a continued fraction expansion. E.g,
+## Find a rational approximation to @var{x} within the tolerance defined
+## by @var{tol} using a continued fraction expansion.  For example,
 ##
 ## @example
 ## rat(pi) = 3 + 1/(7 + 1/16) = 355/113
diff -r fca0dc2fb042 -r 51dc9691f23f scripts/miscellaneous/warning_ids.m
--- a/scripts/miscellaneous/warning_ids.m	Sun Mar 22 11:15:35 2009 -0700
+++ b/scripts/miscellaneous/warning_ids.m	Sun Mar 22 13:14:15 2009 -0700
@@ -36,7 +36,7 @@
 ## 
 ## @example
 ## if (s = t)
-##   ...
+##   @dots{}
 ## @end example
 ## 
 ## @noindent
@@ -45,7 +45,7 @@
 ## 
 ## @example
 ## if (s == t)
-##   ...
+##   @dots{}
 ## @end example
 ## 
 ## @noindent
@@ -57,7 +57,7 @@
 ## 
 ## @example
 ## while (c = getc())
-##   ...
+##   @dots{}
 ## @end example
 ## 
 ## @noindent
@@ -69,7 +69,7 @@
 ## 
 ## @example
 ## if (x = 1)  # intended to test (x == 1)!
-##   ...
+##   @dots{}
 ## @end example
 ## 
 ## @noindent
@@ -81,7 +81,7 @@
 ## 
 ## @example
 ## while ((c = getc()))
-##   ...
+##   @dots{}
 ## @end example
 ## 
 ## @noindent
diff -r fca0dc2fb042 -r 51dc9691f23f src/DLD-FUNCTIONS/dlmread.cc
--- a/src/DLD-FUNCTIONS/dlmread.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/DLD-FUNCTIONS/dlmread.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -154,17 +154,17 @@
 @deftypefnx {Loadable Function} {@var{data} =} dlmread (@var{file}, @var{sep})\n\
 @deftypefnx {Loadable Function} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{r0}, @var{c0})\n\
 @deftypefnx {Loadable Function} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{range})\n\
-Read the matrix @var{data} from a text file. If not defined the separator\n\
-between fields is determined from the file itself. Otherwise the\n\
+Read the matrix @var{data} from a text file.  If not defined the separator\n\
+between fields is determined from the file itself.  Otherwise the\n\
 separation character is defined by @var{sep}.\n\
 \n\
 Given two scalar arguments @var{r0} and @var{c0}, these define the starting\n\
-row and column of the data to be read. These values are indexed from zero,\n\
+row and column of the data to be read.  These values are indexed from zero,\n\
 such that the first row corresponds to an index of zero.\n\
 \n\
 The @var{range} parameter must be a 4 element vector containing  the upper\n\
 left and lower right corner @code{[@var{R0},@var{C0},@var{R1},@var{C1}]} or\n\
-a spreadsheet style range such as 'A2..Q15'. The lowest index value is zero.\n\
+a spreadsheet style range such as 'A2..Q15'.  The lowest index value is zero.\n\
 @end deftypefn")
 {
   octave_value_list retval;
diff -r fca0dc2fb042 -r 51dc9691f23f src/debug.cc
--- a/src/debug.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/debug.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -499,7 +499,7 @@
 String representing the function name.  When already in debug\n\
 mode this should be left out and only the line should be given.\n\
 @item line\n\
-Line number you would like the breakpoint to be set on. Multiple\n\
+Line number you would like the breakpoint to be set on.  Multiple\n\
 lines might be given as separate arguments or as a vector.\n\
 @end table\n\
 \n\
@@ -531,11 +531,11 @@
 String representing the function name.  When already in debug\n\
 mode this should be left out and only the line should be given.\n\
 @item line\n\
-Line number where you would like to remove the breakpoint. Multiple\n\
+Line number where you would like to remove the breakpoint.  Multiple\n\
 lines might be given as separate arguments or as a vector.\n\
 @end table\n\
 No checking is done to make sure that the line you requested is really\n\
-a breakpoint. If you get the wrong line nothing will happen.\n\
+a breakpoint.  If you get the wrong line nothing will happen.\n\
 @seealso{dbstop, dbstatus, dbwhere}\n\
 @end deftypefn")
 {
@@ -994,12 +994,12 @@
 @deftypefn {Command} {} dbstep @var{n}\n\
 @deftypefnx {Command} {} dbstep in\n\
 @deftypefnx {Command} {} dbstep out\n\
-In debugging mode, execute the next @var{n} lines of code. If @var{n} is\n\
-omitted execute the next line of code. If the next line of code is itself\n\
+In debugging mode, execute the next @var{n} lines of code.  If @var{n} is\n\
+omitted execute the next line of code.  If the next line of code is itself\n\
 defined in terms of an m-file remain in the existing function.\n\
 \n\
 Using @code{dbstep in} will cause execution of the next line to step into\n\
-any m-files defined on the next line. Using @code{dbstep out} with cause\n\
+any m-files defined on the next line.  Using @code{dbstep out} with cause\n\
 execution to continue until the current function returns.\n\
 @seealso{dbcont, dbquit}\n\
 @end deftypefn")
diff -r fca0dc2fb042 -r 51dc9691f23f src/error.cc
--- a/src/error.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/error.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -780,10 +780,10 @@
 DEFUN (rethrow, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} rethrow (@var{err})\n\
-Reissues a previous error as defined by @var{err}. @var{err} is a structure\n\
-that must contain at least the 'message' and 'identifier' fields. @var{err}\n\
+Reissues a previous error as defined by @var{err}.  @var{err} is a structure\n\
+that must contain at least the 'message' and 'identifier' fields.  @var{err}\n\
 can also contain a field 'stack' that gives information on the assumed\n\
-location of the error. Typically @var{err} is returned from\n\
+location of the error.  Typically @var{err} is returned from\n\
 @code{lasterror}.\n\
 @seealso{lasterror, lasterr, error}\n\
 @end deftypefn")
@@ -1373,9 +1373,9 @@
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {@var{err} =} lasterror (@var{err})\n\
 @deftypefnx {Built-in Function} {} lasterror ('reset')\n\
-Returns or sets the last error message. Called without any arguments\n\
+Returns or sets the last error message.  Called without any arguments\n\
 returns a structure containing the last error message, as well as other\n\
-information related to this error. The elements of this structure are:\n\
+information related to this error.  The elements of this structure are:\n\
 \n\
 @table @asis\n\
 @item 'message'\n\
@@ -1383,9 +1383,9 @@
 @item 'identifier'\n\
 The message identifier of this error message\n\
 @item 'stack'\n\
-A structure containing information on where the message occurred. This might\n\
+A structure containing information on where the message occurred.  This might\n\
 be an empty structure if this in the case where this information cannot\n\
-be obtained. The fields of this structure are:\n\
+be obtained.  The fields of this structure are:\n\
 \n\
 @table @asis\n\
 @item 'file'\n\
@@ -1400,8 +1400,8 @@
 @end table\n\
 \n\
 The @var{err} structure may also be passed to @code{lasterror} to set the\n\
-information about the last error. The only constraint on @var{err} in that\n\
-case is that it is a scalar structure. Any fields of @var{err} that match\n\
+information about the last error.  The only constraint on @var{err} in that\n\
+case is that it is a scalar structure.  Any fields of @var{err} that match\n\
 the above are set to the value passed in @var{err}, while other fields are\n\
 set to their default values.\n\
 \n\
diff -r fca0dc2fb042 -r 51dc9691f23f src/file-io.cc
--- a/src/file-io.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/file-io.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -754,7 +754,7 @@
 The pointer is positioned @var{offset} characters from the @var{origin},\n\
 which may be one of the predefined variables @code{SEEK_CUR} (current\n\
 position), @code{SEEK_SET} (beginning), or @code{SEEK_END} (end of\n\
-file) or strings \"cof\", \"bof\" or \"eof\". If @var{origin} is omitted,\n\
+file) or strings \"cof\", \"bof\" or \"eof\".  If @var{origin} is omitted,\n\
 @code{SEEK_SET} is assumed.  The offset must be zero, or a value returned\n\
 by @code{ftell} (in which case @var{origin} must be @code{SEEK_SET}).\n\
 \n\
diff -r fca0dc2fb042 -r 51dc9691f23f src/load-save.cc
--- a/src/load-save.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/load-save.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -591,7 +591,7 @@
 @table @code\n\
 @item -force\n\
 The @samp{-force} option is accepted but ignored for backward\n\
-compatibility. Octave now overwrites variables currently in memory with\n\
+compatibility.  Octave now overwrites variables currently in memory with\n\
 the same name as those found in the file.\n\
 \n\
 @item -ascii\n\
@@ -1513,7 +1513,7 @@
 \n\
 @item -zip\n\
 @itemx -z\n\
-Use the gzip algorithm to compress the file. This works equally on files that\n\
+Use the gzip algorithm to compress the file.  This works equally on files that\n\
 are compressed with gzip outside of octave, and gzip can equally be used to\n\
 convert the files for backward compatibility.\n"
 
@@ -1800,7 +1800,7 @@
 Query or set the internal variable that specifies the options used for\n\
 saving the workspace data if Octave aborts.  The value of\n\
 @code{octave_core_file_options} should follow the same format as the\n\
-options for the @code{save} function. The default value is Octave's binary\n\
+options for the @code{save} function.  The default value is Octave's binary\n\
 format.\n\
 @seealso{crash_dumps_octave_core, octave_core_file_name, octave_core_file_limit}\n\
 @end deftypefn")
diff -r fca0dc2fb042 -r 51dc9691f23f src/pr-output.cc
--- a/src/pr-output.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/pr-output.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -3190,7 +3190,7 @@
 @end example\n\
 \n\
 The optional second argument defines the maximum length of the string\n\
-representing the elements of @var{x}. By default @var{len} is 9.\n\
+representing the elements of @var{x}.  By default @var{len} is 9.\n\
 @seealso{format, rat}\n\
 @end deftypefn")
 {
@@ -3675,7 +3675,7 @@
 Insert blank lines above and below column number labels (this is the\n\
 default).\n\
 @item rat\n\
-Print a rational approximation. That is the values are approximated\n\
+Print a rational approximation.  That is the values are approximated\n\
 by one small integer divided by another.\n\
 @end table\n\
 \n\
diff -r fca0dc2fb042 -r 51dc9691f23f src/sysdep.cc
--- a/src/sysdep.cc	Sun Mar 22 11:15:35 2009 -0700
+++ b/src/sysdep.cc	Sun Mar 22 13:14:15 2009 -0700
@@ -660,7 +660,7 @@
 DEFUN (kbhit, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} kbhit ()\n\
-Read a single keystroke from the keyboard. If called with one\n\
+Read a single keystroke from the keyboard.  If called with one\n\
 argument, don't wait for a keypress.  For example,\n\
 \n\
 @example\n\