changeset 27931:0fa21907e54c

doc: grammarcheck documentation ahead of 6.1 release. * basics.txi, container.txi, geometry.txi, uitable.m, print.m, gallery.m, weboptions.m: grammarcheck documentation ahead of 6.1 release.
author Rik <rik@octave.org>
date Fri, 10 Jan 2020 13:19:38 -0800
parents ea1898178973
children b018f553fd85
files doc/interpreter/basics.txi doc/interpreter/container.txi doc/interpreter/geometry.txi scripts/gui/uitable.m scripts/plot/util/print.m scripts/special-matrix/gallery.m scripts/web/weboptions.m
diffstat 7 files changed, 15 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/basics.txi	Fri Jan 10 14:19:28 2020 -0500
+++ b/doc/interpreter/basics.txi	Fri Jan 10 13:19:38 2020 -0800
@@ -361,7 +361,7 @@
 @item @var{config-dir}/octave/octaverc
 @cindex personal startup file
 where @code{@var{config-dir}} is the platform-dependent location for user
-local configuration files (e.g. @w{@env{$XDG_CONFIG_HOME}} on many Unix-like
+local configuration files (e.g., @w{@env{$XDG_CONFIG_HOME}} on many Unix-like
 operating systems or @w{@env{%APPDATA%}} on Windows).
 
 @item ~/.octaverc
--- a/doc/interpreter/container.txi	Fri Jan 10 14:19:28 2020 -0500
+++ b/doc/interpreter/container.txi	Fri Jan 10 13:19:38 2020 -0800
@@ -119,7 +119,6 @@
 structure containing the single field @code{a}, which has a value of 3.
 
 @example
-@group
 x.d.a = 3;
 x.d
      @result{} ans =
@@ -145,7 +144,6 @@
              scalar structure containing the fields:
 
                a =  3
-@end group
 @end example
 
 Note that when Octave prints the value of a structure that contains
--- a/doc/interpreter/geometry.txi	Fri Jan 10 14:19:28 2020 -0500
+++ b/doc/interpreter/geometry.txi	Fri Jan 10 13:19:38 2020 -0800
@@ -464,6 +464,7 @@
 $p' = R \cdot p = R_z \cdot R_y \cdot R_x \cdot p$
 @end tex
 @ifnottex
+
 @example
 p' = Rp = Rz*Ry*Rx*p
 @end example
--- a/scripts/gui/uitable.m	Fri Jan 10 14:19:28 2020 -0500
+++ b/scripts/gui/uitable.m	Fri Jan 10 13:19:38 2020 -0800
@@ -163,6 +163,7 @@
 ##        @@(x, y) update_point_table (y.Indices, t_point_table));
 ## endfunction
 ##
+## @group
 ## function validate_point_table (h, dat, t_data_table)
 ##   if (! (dat.NewData > 0 && ...
 ##     dat.NewData < size (get (t_data_table, "Data"), dat.Indices(1, 1)) + 1))
@@ -172,7 +173,9 @@
 ##     set (h, "Data", d);
 ##   endif
 ## endfunction
+## @end group
 ##
+## @group
 ## function update_column_format (format, indices, t_data_table, ...
 ##                                popup_options)
 ##   cf = get (t_data_table, "ColumnFormat");
@@ -184,14 +187,18 @@
 ##   cf@{indices(1,2)@} = format;
 ##   set (t_data_table, "ColumnFormat", cf);
 ## endfunction
+## @end group
 ##
+## @group
 ## function update_point_table (indices, t_point_table)
 ##   if (isempty (indices))
 ##     indices = [1, 1];
 ##   endif
 ##   set (t_point_table, "Data", indices(1,:));
 ## endfunction
+## @end group
 ##
+## @group
 ## function update_data (b_add, t_point_table, t_type_table, ...
 ##                       t_data_table)
 ##   indices = get (b_add, "UserData");
@@ -204,6 +211,7 @@
 ##   d(p(1,2), p(1,1)) = t_type_table_data(indices(1,2));
 ##   set (t_data_table, "Data", d);
 ## endfunction
+## @end group
 ## @end example
 ##
 ## @seealso{figure, uicontrol}
--- a/scripts/plot/util/print.m	Fri Jan 10 14:19:28 2020 -0500
+++ b/scripts/plot/util/print.m	Fri Jan 10 13:19:38 2020 -0800
@@ -240,8 +240,8 @@
 ##
 ## @item -d@var{device}
 ##   The available output format is specified by the option @var{device}, and
-## is one of the following (devices marked with a "*" are only available with
-## the Gnuplot toolkit):
+## is one of the following (devices marked with a @qcode{'*'} are only
+## available with the Gnuplot toolkit):
 ##
 ## Vector Formats
 ##
--- a/scripts/special-matrix/gallery.m	Fri Jan 10 14:19:28 2020 -0500
+++ b/scripts/special-matrix/gallery.m	Fri Jan 10 13:19:38 2020 -0800
@@ -75,7 +75,7 @@
 ## @deftypefn  {} {@var{a} =} gallery ("condex", @var{n})
 ## @deftypefnx {} {@var{a} =} gallery ("condex", @var{n}, @var{k})
 ## @deftypefnx {} {@var{a} =} gallery ("condex", @var{n}, @var{k}, @var{theta})
-## Create a 'counterexample' matrix to a condition estimator.
+## Create a @nospell{"counterexample"} matrix to a condition estimator.
 ##
 ## @end deftypefn
 ##
@@ -341,7 +341,7 @@
 ##
 ## @deftypefn  {} {@var{a} =} gallery ("smoke", @var{n})
 ## @deftypefnx {} {@var{a} =} gallery ("smoke", @var{n}, @var{k})
-## Create a complex matrix, with a 'smoke ring' pseudospectrum.
+## Create a complex matrix, with a @nospell{"smoke ring"} pseudospectrum.
 ##
 ## @end deftypefn
 ##
--- a/scripts/web/weboptions.m	Fri Jan 10 14:19:28 2020 -0500
+++ b/scripts/web/weboptions.m	Fri Jan 10 13:19:38 2020 -0800
@@ -71,7 +71,7 @@
 ## Default is NULL@.  It must be a string or character vector.
 ## Programming Note: If you display a @code{weboption} object with the Password
 ## property set, the value is displayed as a string containing
-## @qcode{\"*\"}.  However, the object stores the value of the Password
+## @qcode{'*'}.  However, the object stores the value of the Password
 ## property as plain text.
 ##
 ## @item