changeset 27796:e7dd7d98a058

doc: grammarcheck .txi files before 6.1 release. * geometry.txi, install.txi, io.txi, plot.txi, stats.txi, strfind.cc: grammarcheck .txi files before 6.1 release.
author Rik <rik@octave.org>
date Tue, 10 Dec 2019 13:43:36 -0800
parents afbaad39d25c
children 5dcdd5bd46e2
files doc/interpreter/geometry.txi doc/interpreter/install.txi doc/interpreter/io.txi doc/interpreter/plot.txi doc/interpreter/stats.txi libinterp/corefcn/strfind.cc
diffstat 6 files changed, 22 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/geometry.txi	Tue Dec 10 13:19:07 2019 -0800
+++ b/doc/interpreter/geometry.txi	Tue Dec 10 13:43:36 2019 -0800
@@ -454,15 +454,15 @@
 @section Vector Rotation Matrices
 
 Also included in Octave's geometry functions are primitive functions to enable
-vector rotations in 3 dimensional space. Separate functions are provided for
+vector rotations in 3-dimensional space.  Separate functions are provided for
 rotation about each of the principle axes, @var{x}, @var{y}, and @var{z}.
 According to Euler's rotation theorem, any arbitrary rotation, @var{R}, of any
-vector, @var{p}, can be expressed as a product of the three principle rotations:
+vector, @var{p}, can be expressed as a product of the three principle
+rotations:
 
 @tex
 $p' = R \cdot p = R_z \cdot R_y \cdot R_x \cdot p$
 @end tex
-
 @ifnottex
 @example
 p' = Rp = Rz*Ry*Rx*p
@@ -473,4 +473,4 @@
 
 @DOCSTRING(roty)
 
-@DOCSTRING(rotz)
\ No newline at end of file
+@DOCSTRING(rotz)
--- a/doc/interpreter/install.txi	Tue Dec 10 13:19:07 2019 -0800
+++ b/doc/interpreter/install.txi	Tue Dec 10 13:43:36 2019 -0800
@@ -658,7 +658,7 @@
 this way.  If you wish to experiment with large arrays, the following
 information may be helpful.
 
-To determine the integer size of the BLAS library used by Octave, the
+To determine the integer size of the @sc{blas} library used by Octave, the
 following code can be executed:
 
 @example
@@ -671,7 +671,7 @@
 @end group
 @end example
 
-If the BLAS library uses 32-bit integers, an error will be thrown:
+If the @sc{blas} library uses 32-bit integers, an error will be thrown:
 
 @example
 @group
@@ -680,7 +680,7 @@
 @end group
 @end example
 
-Otherwise, if the BLAS library uses 64-bit integers, the result is:
+Otherwise, if the @sc{blas} library uses 64-bit integers, the result is:
 
 @example
 c = 2^31 = 2147483648
--- a/doc/interpreter/io.txi	Tue Dec 10 13:19:07 2019 -0800
+++ b/doc/interpreter/io.txi	Tue Dec 10 13:43:36 2019 -0800
@@ -824,7 +824,7 @@
 file, and there is no concept of precision for the numeric input
 conversions as there is for the corresponding output conversions.
 Ordinarily, non-whitespace characters in the template are expected to
-match characters in the input stream exactly. For example, note that
+match characters in the input stream exactly.  For example, note that
 @code{sscanf} parses the string and whitespace differently when using
 mixed numeric and string output types:
 @cindex conversion specifications (@code{scanf})
@@ -1010,7 +1010,7 @@
 64-bit integers are used.
 
 The @samp{%e}, @samp{%f}, @samp{%g}, @samp{%E}, and @samp{%G} conversions
-match optionally signed floating-point numbers. All five conversion
+match optionally signed floating-point numbers.  All five conversion
 specifications behave identically, and will read in numerical values of
 any floating point display style.
 
--- a/doc/interpreter/plot.txi	Tue Dec 10 13:19:07 2019 -0800
+++ b/doc/interpreter/plot.txi	Tue Dec 10 13:43:36 2019 -0800
@@ -2651,7 +2651,7 @@
 interfaces, known as terminals.  Octave normally chooses a default terminal,
 but you can override this with the environment variable @env{GNUTERM}.  This
 variable may be set in the shell before starting Octave or from within Octave
-before plotting for the first time.  For example,
+before plotting for the first time.  For example:
 
 @example
 @group
--- a/doc/interpreter/stats.txi	Tue Dec 10 13:19:07 2019 -0800
+++ b/doc/interpreter/stats.txi	Tue Dec 10 13:43:36 2019 -0800
@@ -111,10 +111,12 @@
 @node Statistics on Sliding Windows of Data
 @section Statistics on Sliding Windows of Data
 
-It is often useful to calculate descriptive statistics over a subsection (i.e., window) of a full dataset.  Octave provides the function @code{movfun} which
-will call an arbitrary function handle with windows of data and accumulate
-the results.  Many of the most commonly desired functions, such as the moving
-average over a window of data (@code{movmean}), are already provided.
+It is often useful to calculate descriptive statistics over a subsection
+(i.e., window) of a full dataset.  Octave provides the function @code{movfun}
+which will call an arbitrary function handle with windows of data and
+accumulate the results.  Many of the most commonly desired functions, such as
+the moving average over a window of data (@code{movmean}), are already
+provided.
 
 @DOCSTRING(movfun)
 
--- a/libinterp/corefcn/strfind.cc	Tue Dec 10 13:19:07 2019 -0800
+++ b/libinterp/corefcn/strfind.cc	Tue Dec 10 13:43:36 2019 -0800
@@ -175,10 +175,14 @@
 @group
 strfind ("abababa", "aba")
      @result{} [1, 3, 5]
+@end group
 
+@group
 strfind ("abababa", "aba", "overlaps", false)
      @result{} [1, 5]
+@end group
 
+@group
 strfind (@{"abababa", "bebebe", "ab"@}, "aba")
      @result{}
         @{
@@ -189,7 +193,9 @@
           [1,2] = [](1x0)
           [1,3] = [](1x0)
         @}
+@end group
 
+@group
 strfind ("abababa", "aba", "forcecelloutput", true)
      @result{}
         @{