changeset 32487:998cba4600e9 stable

doc: grammarcheck m-files before 9.1 release. * scripts/help/bytecode.m, scripts/linear-algebra/tensorprod.m, scripts/optimization/optimget.m, scripts/optimization/optimset.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/util/print.m, scripts/set/ismembertol.m, scripts/statistics/cov.m, scripts/statistics/mad.m, scripts/time/datenum.m: grammarcheck m-files before 9.1 release.
author Rik <rik@octave.org>
date Thu, 23 Nov 2023 18:28:08 -0800
parents d8120936e4a5
children d7a3ed7f2fdc
files scripts/help/bytecode.m scripts/linear-algebra/tensorprod.m scripts/optimization/optimget.m scripts/optimization/optimset.m scripts/plot/appearance/xlim.m scripts/plot/appearance/ylim.m scripts/plot/appearance/zlim.m scripts/plot/draw/quiver.m scripts/plot/draw/quiver3.m scripts/plot/util/print.m scripts/set/ismembertol.m scripts/statistics/cov.m scripts/statistics/mad.m scripts/time/datenum.m
diffstat 14 files changed, 37 insertions(+), 35 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/help/bytecode.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/help/bytecode.m	Thu Nov 23 18:28:08 2023 -0800
@@ -28,8 +28,8 @@
 ## Summary of commands related to Octave's bytecode interpreter.
 ##
 ## As of Octave 9, the bytecode interpreter is considered @emph{experimental}.
-## The user is encouraged to test it with that in mind. All bytecode functions,
-## being experimental, may be renamed in future.
+## The user is encouraged to test it with that in mind.  All bytecode
+## functions, being experimental, may be renamed in future.
 ##
 ## To switch on the bytecode interpreter, type: @code{__vm_enable__ (1)}
 ##
--- a/scripts/linear-algebra/tensorprod.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/linear-algebra/tensorprod.m	Thu Nov 23 18:28:08 2023 -0800
@@ -51,7 +51,7 @@
 ## @var{C}.  The specified @var{value} should be the total number of dimensions
 ## of @var{A}.
 ##
-## Matlab Compatibility: Octave does not currently support the
+## @sc{matlab} Compatibility: Octave does not currently support the
 ## @qcode{"@var{property_name}=@var{value}"} syntax for the
 ## @qcode{"NumDimensionsA"} parameter.
 ##
--- a/scripts/optimization/optimget.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/optimization/optimget.m	Thu Nov 23 18:28:08 2023 -0800
@@ -36,12 +36,12 @@
 ## @code{optimget} will attempt to match @var{par} to a standard parameter
 ## and will return that parameter's value if a match is found.  Matching is
 ## case insensitive and is based on character matching at the start of the
-## parameter name. @code{optimget} produces an error if it finds multiple
-## ambiguous matches. If no standard parameter matches are found a warning is
+## parameter name.  @code{optimget} produces an error if it finds multiple
+## ambiguous matches.  If no standard parameter matches are found a warning is
 ## issued.  See @code{optimset} for information about the standard options
 ## list.
 ##
-## Note:  Only parameter names from the standard list are considered when
+## Note: Only parameter names from the standard list are considered when
 ## matching short parameter names, and @var{par} will always be expanded to
 ## match a standard parameter even if an exact non-standard match exists.  The
 ## value of a non-standard parameter that is ambigious with one or more
--- a/scripts/optimization/optimset.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/optimization/optimset.m	Thu Nov 23 18:28:08 2023 -0800
@@ -125,18 +125,18 @@
 ## @item Updating
 ## @end table
 ##
-## This list can be extended by the user or other loaded Octave packages. An
+## This list can be extended by the user or other loaded Octave packages.  An
 ## updated valid parameters list can be queried using the no-argument form of
 ## @code{optimset}.
 ##
-## Note 1:  Only parameter names from the standard list are considered when
+## Note 1: Only parameter names from the standard list are considered when
 ## matching short parameter names, and @var{par} will always be expanded
 ## to match a standard parameter even if an exact non-standard match exists.
 ## The value of a non-standard parameter that is ambigious with one or more
 ## standard parameters cannot be set by @code{optimset} and can only be set
 ## using @code{setfield} or dot notation for structs.
 ##
-## Note 2:  The optimization options structure is primarily intended for
+## Note 2: The optimization options structure is primarily intended for
 ## manipulation of known parameters by @code{optimset} and @code{optimget}.
 ## Unpredictable behavior on future calls to @code{optimset} or
 ## @code{optimget} can result from creating non-standard or ambiguous
--- a/scripts/plot/appearance/xlim.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/appearance/xlim.m	Thu Nov 23 18:28:08 2023 -0800
@@ -48,7 +48,7 @@
 ## The special values -Inf and Inf can be used to indicate that either
 ## the lower axis limit or upper axis limit should be automatically calculated.
 ##
-## The current limit calculation "mode" may be one of
+## The current limit calculation @qcode{"mode"} may be one of
 ##
 ## @table @asis
 ## @item @qcode{"auto"} (default)
--- a/scripts/plot/appearance/ylim.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/appearance/ylim.m	Thu Nov 23 18:28:08 2023 -0800
@@ -48,7 +48,7 @@
 ## The special values -Inf and Inf can be used to indicate that either
 ## the lower axis limit or upper axis limit should be automatically calculated.
 ##
-## The current limit calculation "mode" may be one of
+## The current limit calculation @qcode{"mode"} may be one of
 ##
 ## @table @asis
 ## @item @qcode{"auto"} (default)
--- a/scripts/plot/appearance/zlim.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/appearance/zlim.m	Thu Nov 23 18:28:08 2023 -0800
@@ -48,7 +48,7 @@
 ## The special values -Inf and Inf can be used to indicate that either
 ## the lower axis limit or upper axis limit should be automatically calculated.
 ##
-## The current limit calculation "mode" may be one of
+## The current limit calculation @qcode{"mode"} may be one of
 ##
 ## @table @asis
 ## @item @qcode{"auto"} (default)
--- a/scripts/plot/draw/quiver.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/draw/quiver.m	Thu Nov 23 18:28:08 2023 -0800
@@ -46,7 +46,7 @@
 ## The optional input @var{s} is a scalar defining a scaling factor to use for
 ## the arrows of the field relative to the mesh spacing.  A value of 1.0 will
 ## result in the longest vector exactly filling one grid square.  A value of 0
-## or "off" disables all scaling.  The default value is 0.9.
+## or @qcode{"off"} disables all scaling.  The default value is 0.9.
 ##
 ## The style to use for the plot can be defined with a line style, @var{style},
 ## of the same format as the @code{plot} command.  If a marker is specified
--- a/scripts/plot/draw/quiver3.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/draw/quiver3.m	Thu Nov 23 18:28:08 2023 -0800
@@ -46,7 +46,7 @@
 ## The optional input @var{s} is a scalar defining a scaling factor to use for
 ## the arrows of the field relative to the mesh spacing.  A value of 1.0 will
 ## result in the longest vector exactly filling one grid cube.  A value of 0
-## or "off" disables all scaling.  The default value is 0.9.
+## or @qcode{"off"} disables all scaling.  The default value is 0.9.
 ##
 ## The style to use for the plot can be defined with a line style @var{style}
 ## of the same format as the @code{plot} command.  If a marker is specified
--- a/scripts/plot/util/print.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/plot/util/print.m	Thu Nov 23 18:28:08 2023 -0800
@@ -157,7 +157,7 @@
 ## Caution: If Octave was built against Qt version earlier than 5.13,
 ## @option{-svgconvert} may lead to inaccurate rendering of image objects.
 ##
-## @item -polymerge
+## @item  -polymerge
 ## @itemx -nopolymerge
 ## @itemx -polymerge-all
 ##   When using the SVG based backend @option{-svgconvert}, faces are rendered
--- a/scripts/set/ismembertol.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/set/ismembertol.m	Thu Nov 23 18:28:08 2023 -0800
@@ -28,15 +28,15 @@
 ## @deftypefnx {} {@var{tf} =} ismembertol (@var{a}, @var{s}, @var{tol})
 ## @deftypefnx {} {@var{tf} =} ismembertol (@var{a}, @var{s}, @var{name}, @var{value})
 ## @deftypefnx {} {[@var{tf}, @var{s_idx}] =} ismembertol (@dots{})
-## Check if values are member of a set within a tolerance.
+## Check if values are members of a set within a tolerance.
 ##
 ## This functions returns a logical matrix @var{tf} with the same shape as
 ## @var{a} which is true (1) where the element in @var{a} is close to @var{s}
 ## within a tolerance @var{tol} and false (0) if it is not.  If @var{tol} is
-## not provided, a default tolerance of @qcode{1e-6} is used.
+## not specified, a default tolerance of @code{1e-6} is used.
 ##
-## If a second output argument is requested, then the index into @var{s} of
-## each matching element is also returned.
+## If a second output argument is requested then the index into @var{s} of each
+## matching element is also returned.
 ##
 ## The inputs @var{a} and @var{s} must be numeric values.
 ##
@@ -50,35 +50,37 @@
 ## @end group
 ## @end example
 ##
-## Optional property-value pairs @var{name} and @var{value} might be given.
-## For each of these pairs, the @var{name} might be one of the following
-## strings:
+## Optional property/value pairs may be given to change the function's
+## behavior.  The property may be one of following strings:
 ##
 ## @table @asis
 ## @item @qcode{"ByRows"}
-## If set to @qcode{false} (default), all elements in @var{a} and @var{s} are
-## treated separately.  If set to @qcode{true}, @var{tf} contains @qcode{true}
+## If set to @code{false} (default), all elements in @var{a} and @var{s} are
+## treated separately.  If set to @code{true}, @var{tf} will be @code{true}
 ## for each row in @var{a} that matches a row in @var{s} within the given
 ## tolerance.  Two rows, @var{u} and @var{v}, are within tolerance if they
-## fullfill the condition @qcode{all (abs (u-v) <= tol*max (abs ([a;s])))}.
+## fulfill the condition @code{all (abs (u-v) <= tol*max (abs ([a;s])))}.
 ##
 ## @item @qcode{"OutputAllIndices"}
-## If set to @qcode{false} (default), @var{s_idx} contains indices for one
-## of the matches.  If set to @qcode{true}, @var{s_idx} is a cell array
+## If set to @code{false} (default), @var{s_idx} contains indices for one
+## of the matches.  If set to @code{true}, @var{s_idx} is a cell array
 ## containing the indices for all elements in @var{s} that are within tolerance
 ## of the corresponding value in @var{a}.
 ##
 ## @item @qcode{"DataScale"}
-## The corresponding value @var{DS} is used to change the scale factor in the
-## tolerance test to @qcode{abs(u-v) <= tol*DS}.  By default, the maximum
+## The provided value @var{DS} is used to change the scale factor in the
+## tolerance test to @code{abs (u-v) <= tol*@var{DS}}.  By default, the maximum
 ## absolute value in @var{a} and @var{s} is used as the scale factor.
 ## @end table
 ##
 ## Example:
+##
 ## @example
+## @group
 ## s = [1:6].' * pi;
 ## a = 10.^log10 (x);
 ## [tf, s_idx] = ismembertol (a, s);
+## @end group
 ## @end example
 ##
 ## @seealso{ismember, lookup, unique, union, intersect, setdiff, setxor}
--- a/scripts/statistics/cov.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/statistics/cov.m	Thu Nov 23 18:28:08 2023 -0800
@@ -98,7 +98,7 @@
 ##   @math{N}, being used to calculated each element of the covariance matrix.
 ## @end table
 ##
-## Compatibility Note:  Previous versions of @code{cov} treated rows
+## Compatibility Note: Previous versions of @code{cov} treated rows
 ## @var{x} and @var{y} as multivariate random variables.  This version
 ## attempts to maintain full compatibility with @sc{matlab} by treating
 ## @var{x} and @var{y} as two univariate distributions regardless of shape,
--- a/scripts/statistics/mad.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/statistics/mad.m	Thu Nov 23 18:28:08 2023 -0800
@@ -44,12 +44,12 @@
 ## @var{mad} = median (abs (@var{x} - median (@var{x})))
 ## @end example
 ##
-## If @var{x} is a vector, compute @code{mad} for each element in @var{x}. If
+## If @var{x} is a vector, compute @code{mad} for each element in @var{x}.  If
 ## @var{x} is an array the calculation is performed over the first
 ## non-singleton dimension.
 ##
 ## @code{mad} excludes NaN values from calculation similar to using the
-## @qcode{omitnan} option in @code{var}, @code{mean}, and @code{median}.
+## @code{omitnan} option in @code{var}, @code{mean}, and @code{median}.
 ##
 ## The optional argument @var{opt} determines whether mean or median absolute
 ## deviation is calculated.  The default is 0 which corresponds to mean
--- a/scripts/time/datenum.m	Wed Nov 22 16:04:41 2023 -0800
+++ b/scripts/time/datenum.m	Thu Nov 23 18:28:08 2023 -0800
@@ -54,9 +54,9 @@
 ## time component will have the value set to zero.  Formats which do not
 ## specify a date will default to January 1st of the current year.
 ##
-## When passing separate @var{year}, @var{month}, @var{day}, etc. arguments,
-## each may be a scalar or nonscalar array. Nonscalar inputs must all be of
-## the same size. Scalar inputs will be expanded to be the size of the
+## When passing separate @var{year}, @var{month}, @var{day}, etc.@: arguments,
+## each may be a scalar or nonscalar array.  Nonscalar inputs must all be of
+## the same size.  Scalar inputs will be expanded to be the size of the
 ## nonscalar inputs.
 ##
 ## @var{p} is the year at the start of the century to which two-digit years