Mercurial > octave
changeset 27794:45ad2127582b
doc: grammarcheck scripts before 6.1 release.
* num2str.m, rescale.m, rotx.m, roty.m, rotz.m, tar_is_bsd.m, pkg.m, gtext.m,
polar.m, smooth3.m, stream2.m, stream3.m, streamline.m, streamtube.m, print.m,
unique.m, movmedian.m, movprod.m, movstd.m, movsum.m:
grammarcheck scripts before 6.1 release.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 10 Dec 2019 12:19:09 -0800 |
parents | 507d2e0fcb43 |
children | afbaad39d25c |
files | scripts/general/num2str.m scripts/general/rescale.m scripts/geometry/rotx.m scripts/geometry/roty.m scripts/geometry/rotz.m scripts/miscellaneous/private/tar_is_bsd.m scripts/pkg/pkg.m scripts/plot/appearance/gtext.m scripts/plot/draw/polar.m scripts/plot/draw/smooth3.m scripts/plot/draw/stream2.m scripts/plot/draw/stream3.m scripts/plot/draw/streamline.m scripts/plot/draw/streamtube.m scripts/plot/util/print.m scripts/set/unique.m scripts/statistics/movmedian.m scripts/statistics/movprod.m scripts/statistics/movstd.m scripts/statistics/movsum.m |
diffstat | 20 files changed, 95 insertions(+), 88 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/general/num2str.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/general/num2str.m Tue Dec 10 12:19:09 2019 -0800 @@ -30,7 +30,6 @@ ## Examples: ## ## @example -## @group ## num2str (123.456) ## @result{} 123.456 ## @@ -50,7 +49,6 @@ ## ## num2str (1.234 + 27.3i) ## @result{} 1.234+27.3i -## @end group ## @end example ## ## The @code{num2str} function is not very flexible. For better control
--- a/scripts/general/rescale.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/general/rescale.m Tue Dec 10 12:19:09 2019 -0800 @@ -36,7 +36,7 @@ ## are taken from the data itself (@w{@code{@var{inmin} = min (A(:))}} and ## @w{@code{@var{inmax} = max (A(:))}}). ## -## Programming Notes: +## Programming Notes: ## The applied formula is ## ## @tex
--- a/scripts/geometry/rotx.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/geometry/rotx.m Tue Dec 10 12:19:09 2019 -0800 @@ -21,7 +21,7 @@ ## ## @code{rotx} returns the 3x3 transformation matrix corresponding to an active ## rotation of the vector about the x-axis by the specified @var{angle}, given -## in degrees, where a positive angle corresponds to a counter-clockwise +## in degrees, where a positive angle corresponds to a counterclockwise ## rotation when viewing the y-z plane from the positive x side. ## ## The form of the transformation matrix is:
--- a/scripts/geometry/roty.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/geometry/roty.m Tue Dec 10 12:19:09 2019 -0800 @@ -21,7 +21,7 @@ ## ## @code{roty} returns the 3x3 transformation matrix corresponding to an active ## rotation of a vector about the y-axis by the specified @var{angle}, given in -## degrees, where a positive angle corresponds to a counter-clockwise +## degrees, where a positive angle corresponds to a counterclockwise ## rotation when viewing the z-x plane from the positive y side. ## ## The form of the transformation matrix is:
--- a/scripts/geometry/rotz.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/geometry/rotz.m Tue Dec 10 12:19:09 2019 -0800 @@ -21,7 +21,7 @@ ## ## @code{rotz} returns the 3x3 transformation matrix corresponding to an active ## rotation of a vector about the z-axis by the specified @var{angle}, given in -## degrees, where a positive angle corresponds to a counter-clockwise +## degrees, where a positive angle corresponds to a counterclockwise ## rotation when viewing the x-y plane from the positive z side. ## ## The form of the transformation matrix is:
--- a/scripts/miscellaneous/private/tar_is_bsd.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/miscellaneous/private/tar_is_bsd.m Tue Dec 10 12:19:09 2019 -0800 @@ -17,14 +17,14 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {@var{out} =} tar_is_bsd () +## @deftypefn {} {@var{out} =} tar_is_bsd () ## True if the default tar command is BSD tar. ## ## Checks whether the default tar command (the one invoked when an un-prefixed -## @code{tar} is executed) is BSD tar or another tar. Caches the results for +## @code{tar} is executed) is BSD tar or another tar. Caches the results for ## performance. ## -## Returns true if the detected tar is BSD tar, and false otherwise. Errors if +## Returns true if the detected tar is BSD tar, and false otherwise. Errors if ## @code{tar --version} does not succeed. ## @end deftypefn
--- a/scripts/pkg/pkg.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/pkg/pkg.m Tue Dec 10 12:19:09 2019 -0800 @@ -47,7 +47,7 @@ ## @end example ## ## @noindent -## installs the package found in the given URL. This +## installs the package found in the given URL@. This ## requires an internet connection and the cURL library. ## ## @noindent @@ -186,8 +186,10 @@ ## Display can be limited to a set of packages: ## ## @example +## @group ## ## describe control and signal packages ## pkg describe control signal +## @end group ## @end example ## ## If one output is requested a cell of structure containing the
--- a/scripts/plot/appearance/gtext.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/appearance/gtext.m Tue Dec 10 12:19:09 2019 -0800 @@ -26,19 +26,22 @@ ## ## The string argument @var{s} may be a character array or a cell array ## of strings. If @var{s} has more than one row, each row is used -## to create a separate text object after a mouse click. For example: +## to create a separate text object after a mouse click. For example: ## ## Place a single string after one mouse click +## ## @example ## gtext ("I clicked here") ## @end example ## ## Place two strings after two mouse clicks +## ## @example ## gtext (@{"I clicked here"; "and there"@}) ## @end example ## ## Place two strings, each with two lines, after two mouse clicks +## ## @example ## gtext (@{"I clicked", "here"; "and", "there"@}) ## @end example
--- a/scripts/plot/draw/polar.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/polar.m Tue Dec 10 12:19:09 2019 -0800 @@ -26,7 +26,7 @@ ## Create a 2-D plot from polar coordinates @var{theta} and @var{rho}. ## ## The input @var{theta} is assumed to be radians and is converted to degrees -## for plotting. If you have degrees then you must convert +## for plotting. If you have degrees then you must convert ## (@pxref{XREFcart2pol,,cart2pol}) to radians before passing the data to this ## function. ##
--- a/scripts/plot/draw/smooth3.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/smooth3.m Tue Dec 10 12:19:09 2019 -0800 @@ -26,7 +26,7 @@ ## This function may be used, for example, to reduce the impact of noise in ## @var{data} before calculating isosurfaces. ## -## @var{data} must be a non-singleton 3-dimensional matrix. The output +## @var{data} must be a non-singleton 3-dimensional matrix. The output ## @var{smoothed_data} is a matrix of the same size as @var{data}. ## ## The option input @var{method} determines which convolution kernel is used
--- a/scripts/plot/draw/stream2.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/stream2.m Tue Dec 10 12:19:09 2019 -0800 @@ -20,21 +20,21 @@ ## @deftypefn {} {@var{xy} =} stream2 (@var{x}, @var{y}, @var{u}, @var{v}, @var{sx}, @var{sy}) ## @deftypefnx {} {@var{xy} =} stream2 (@var{u}, @var{v}, @var{sx}, @var{sy}) ## @deftypefnx {} {@var{xy} =} stream2 (@dots{}, "@var{options}") -## Compute 2D streamline data. +## Compute 2-D streamline data. ## -## Calculates streamlines of a vector field given by [@var{u}, @var{v}]. +## Calculates streamlines of a vector field given by @code{[@var{u}, @var{v}]}. ## The vector field is defined over a rectangular grid given by -## [@var{x}, @var{y}]. The streamlines start at the seed points -## [@var{sx}, @var{sy}]. The returned value @var{xy} contains a cell array -## of vertex arrays. If the starting point is outside the vector field, -## [] is returned. +## @code{[@var{x}, @var{y}]}. The streamlines start at the seed points +## @code{[@var{sx}, @var{sy}]}. The returned value @var{xy} contains a cell +## array of vertex arrays. If the starting point is outside the vector field, +## @code{[]} is returned. ## -## The input parameter @var{options} is a 2D vector of the form -## [@var{stepsize}, @var{maxnumbervertices}]. The first parameter specifies -## the step size used for trajectory integration (default 0.1). It is -## allowed to set a negative value to control the direction of integration. +## The input parameter @var{options} is a 2-D vector of the form +## @code{[@var{stepsize}, @var{maxnumbervertices}]}. The first parameter +## specifies the step size used for trajectory integration (default 0.1). It +## is allowed to set a negative value to control the direction of integration. ## The second parameter specifies the maximum number of segments used to -## create a streamline (default 10000). +## create a streamline (default 10,000). ## ## The return value @var{xy} is a @nospell{nverts x 2} matrix containing the ## coordinates of the field line segments.
--- a/scripts/plot/draw/stream3.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/stream3.m Tue Dec 10 12:19:09 2019 -0800 @@ -20,21 +20,21 @@ ## @deftypefn {} {@var{xyz} =} stream3 (@var{x}, @var{y}, @var{z}, @var{u}, @var{v}, @var{w}, @var{sx}, @var{sy}, @var{sz}) ## @deftypefnx {} {@var{xyz} =} stream3 (@var{u}, @var{v}, @var{w}, @var{sx}, @var{sy}, @var{sz}) ## @deftypefnx {} {@var{xyz} =} stream3 (@dots{}, "@var{options}") -## Compute 3D streamline data. +## Compute 3-D streamline data. ## -## Calculates streamlines of a vector field given by [@var{u}, @var{v}, @var{w}]. -## The vector field is defined over a rectangular grid given by -## [@var{x}, @var{y}, @var{z}]. The streamlines start at the seed points -## [@var{sx}, @var{sy}, @var{sz}]. The returned value @var{xyz} -## contains a cell array of vertex arrays. If the starting point is outside -## the vector field, [] is returned. +## Calculate streamlines of a vector field given by @code{[@var{u}, @var{v}, +## @var{w}]}. The vector field is defined over a rectangular grid given by +## @code{[@var{x}, @var{y}, @var{z}]}. The streamlines start at the seed +## points @code{[@var{sx}, @var{sy}, @var{sz}]}. The returned value @var{xyz} +## contains a cell array of vertex arrays. If the starting point is outside +## the vector field, @code{[]} is returned. ## -## The input parameter @var{options} is a 2D vector of the form -## [@var{stepsize}, @var{maxnumbervertices}]. The first parameter specifies -## the step size used for trajectory integration (default 0.1). It is -## allowed to set a negative value to control the direction of integration. +## The input parameter @var{options} is a 2-D vector of the form +## @code{[@var{stepsize}, @var{maxnumbervertices}]}. The first parameter +## specifies the step size used for trajectory integration (default 0.1). It +## is allowed to set a negative value to control the direction of integration. ## The second parameter specifies the maximum number of segments used to -## create a streamline (default 10000). +## create a streamline (default 10,000). ## ## The return value @var{xyz} is a @nospell{nverts x 3} matrix containing the ## coordinates of the field line segments. @@ -51,7 +51,7 @@ ## @end group ## @end example ## -## @seealso{streamline, stream2} +## @seealso{stream2, streamline, streamtube} ## ## @end deftypefn
--- a/scripts/plot/draw/streamline.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/streamline.m Tue Dec 10 12:19:09 2019 -0800 @@ -22,20 +22,20 @@ ## @deftypefnx {} {} streamline (@dots{}, "@var{options}") ## @deftypefnx {} {} streamline (@var{hax}, @dots{}) ## @deftypefnx {} {@var{h} =} streamline (@dots{}) -## Plot streamlines of 2D or 3D vector fields. +## Plot streamlines of 2-D or 3-D vector fields. ## -## Plot streamlines of a 2D or 3D vector field given by -## [@var{u}, @var{v}] or [@var{u}, @var{v}, @var{w}]. The vector field -## is defined over a rectangular grid given by [@var{x}, @var{y}] -## or [@var{x}, @var{y}, @var{z}]. The streamlines start at the seed -## points [@var{sx}, @var{sy}] or [@var{sx}, @var{sy}, @var{sz}]. +## Plot streamlines of a 2-D or 3-D vector field given by +## @code{[@var{u}, @var{v}]} or @code{[@var{u}, @var{v}, @var{w}]}. The vector +## field is defined over a rectangular grid given by @code{[@var{x}, @var{y}]} +## or @code{[@var{x}, @var{y}, @var{z}]}. The streamlines start at the seed +## points @code{[@var{sx}, @var{sy}]} or @code{[@var{sx}, @var{sy}, @var{sz}]}. ## -## The input parameter @var{options} is a 2D vector of the form -## [@var{stepsize}, @var{maxnumbervertices}]. The first parameter specifies -## the step size used for trajectory integration (default 0.1). It is -## allowed to set a negative value to control the direction of integration. +## The input parameter @var{options} is a 2-D vector of the form +## @code{[@var{stepsize}, @var{maxnumbervertices}]}. The first parameter +## specifies the step size used for trajectory integration (default 0.1). It +## is allowed to set a negative value to control the direction of integration. ## The second parameter specifies the maximum number of segments used to -## create a streamline (default 10000). +## create a streamline (default 10,000). ## ## If the first argument @var{hax} is an axes handle, then plot into this axes, ## rather than the current axes returned by @code{gca}. @@ -54,7 +54,7 @@ ## @end group ## @end example ## -## @seealso{stream2, stream3} +## @seealso{stream2, stream3, streamtube} ## ## @end deftypefn
--- a/scripts/plot/draw/streamtube.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/draw/streamtube.m Tue Dec 10 12:19:09 2019 -0800 @@ -26,24 +26,25 @@ ## Calculate and display streamtubes. ## ## Streamtubes are approximated by connecting circular crossflow areas -## along a streamline. The expansion of the flow is determined by the local +## along a streamline. The expansion of the flow is determined by the local ## crossflow divergence. ## -## The vector field is given by [@var{u}, @var{v}, @var{w}] and is defined over a -## rectangular grid given by [@var{x}, @var{y}, @var{z}]. The streamtubes start -## at the seed points [@var{sx}, @var{sy}, @var{sz}]. +## The vector field is given by @code{[@var{u}, @var{v}, @var{w}]} and is +## defined over a rectangular grid given by @code{[@var{x}, @var{y}, @var{z}]}. +## The streamtubes start at the seed points +## @code{[@var{sx}, @var{sy}, @var{sz}]}. ## ## The tubes are colored depending on the local vector field strength. ## -## The input parameter @var{options} is a 2D vector of the form -## [@var{scale}, @var{n}]. The first parameter scales the start radius of -## the streamtubes (default 1). The second parameter specifies the number of -## patches used for the streamtube circumference (default 20). +## The input parameter @var{options} is a 2-D vector of the form +## @code{[@var{scale}, @var{n}]}. The first parameter scales the start radius +## of the streamtubes (default 1). The second parameter specifies the number +## of patches used for the streamtube circumference (default 20). ## -## Streamtube can be called with a cell array containing precomputed streamline -## data. To do this, @var{vertices} must be created with the stream3 function. -## This option is useful if you need to alter the integrator step size or the -## maximum number of vertices of the streamline. +## @code{streamtube} can be called with a cell array containing precomputed +## streamline data. To do this, @var{vertices} must be created with the +## @code{stream3} function. This option is useful if you need to alter the +## integrator step size or the maximum number of vertices of the streamline. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes, ## rather than the current axes returned by @code{gca}. @@ -63,7 +64,7 @@ ## @end group ## @end example ## -## @seealso{streamline, stream3} +## @seealso{stream3, streamline} ## ## @end deftypefn
--- a/scripts/plot/util/print.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/plot/util/print.m Tue Dec 10 12:19:09 2019 -0800 @@ -114,10 +114,10 @@ ## Specifies whether the opengl (pixel-based) or painters (vector-based) ## renderer is used. This is equivalent to changing the figure's ## @qcode{"Renderer"} property. When the figure @code{RendererMode} property -## is @qcode{"auto"} (the default) Octave will use the @qcode{"opengl"} renderer -## for raster formats (e.g., JPEG) and @qcode{"painters"} for vector formats -## (e.g., PDF). -## Those options are only supported for the "qt" graphics tookit. +## is @qcode{"auto"} (the default) Octave will use the @qcode{"opengl"} +## renderer for raster formats (e.g., JPEG) and @qcode{"painters"} for +## vector formats (e.g., PDF). Those options are only supported for the "qt" +## graphics tookit. ## ## @item -svgconvert ## When using the -painters renderer, this enables a different backend @@ -127,11 +127,14 @@ ## @item Font handling: ## The actual font is embedded in the output file which allows for printing ## arbitrary characters and fonts in all vector formats. +## ## @item Output Simplification: -## By default, the @code{-painters} renders patch and surface objects +## By default, the @option{-painters} renders patch and surface objects ## using assemblies of triangles. This may lead to anti-aliasing -## artifacts when viewing the file. The @code{-svgconvert} option reconstructs -## polygons in order to avoid those artifacts (particularly for 2-D figures). +## artifacts when viewing the file. The @option{-svgconvert} option +## reconstructs polygons in order to avoid those artifacts (particularly for +## 2-D figures). +## ## @item Transparency: ## Allows for printing transparent graphics objects in PDF format. ## For PostScript formats the presence of any transparent object will cause the @@ -257,7 +260,7 @@ ## Encapsulated PostScript (level 1 and 2, mono and color). ## ## The OpenGL-based graphics toolkits always generate PostScript level 3.0. -## They have limited support for text unless using the @code{-svgconvert} +## They have limited support for text unless using the @option{-svgconvert} ## option. ## Limitations include using only ASCII characters (e.g., no Greek letters) ## and support for just three base PostScript fonts: Helvetica (the default),
--- a/scripts/set/unique.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/set/unique.m Tue Dec 10 12:19:09 2019 -0800 @@ -55,9 +55,9 @@ ## @example ## @group ## unique ([3, 1, 1, 2]) -## @result{} [1, 2, 3] +## @result{} [1, 2, 3] ## unique ([3, 1, 1, 2], "stable") -## @result{} [3, 1, 2] +## @result{} [3, 1, 2] ## @end group ## @end example ## @@ -66,9 +66,9 @@ ## @example ## @group ## [~, @var{i}] = unique ([3, 1, 1, 2], "first") -## @result{} @var{i} = [2; 4; 1] +## @result{} @var{i} = [2; 4; 1] ## [~, @var{i}] = unique ([3, 1, 1, 2], "last") -## @result{} @var{i} = [3; 4; 1] +## @result{} @var{i} = [3; 4; 1] ## @end group ## @end example ##
--- a/scripts/statistics/movmedian.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/statistics/movmedian.m Tue Dec 10 12:19:09 2019 -0800 @@ -49,9 +49,9 @@ ## ## The optional string argument @qcode{"@var{nancond}"} controls whether ## @code{NaN} and @code{NA} values should be included (@qcode{"includenan"}), -## or excluded (@qcode{"omitnan"}), from the data passed to @code{movmedian}. The -## default is @qcode{"includenan"}. Caution: the @qcode{"omitnan"} option is -## not yet implemented. +## or excluded (@qcode{"omitnan"}), from the data passed to +## @code{movmedian}. The default is @qcode{"includenan"}. Caution: the +## @qcode{"omitnan"} option is not yet implemented. ## ## The calculation can be controlled by specifying @var{property}/@var{value} ## pairs. Valid properties are @@ -85,8 +85,8 @@ ## @code{@var{y}(1) = movmedian ([NaN, @var{x}(1:2)])}, and ## @code{@var{y}(end) = movmedian ([@var{x}(end-1:end), NaN])}. ## This option usually results in @var{y} having @code{NaN} values at the -## boundaries, although it is influenced by how @code{movmedian} handles @code{NaN}, -## and also by the property @qcode{"nancond"}. +## boundaries, although it is influenced by how @code{movmedian} handles +## @code{NaN}, and also by the property @qcode{"nancond"}. ## ## @item @var{user_value} ## Any window elements outside the data array are replaced by the specified
--- a/scripts/statistics/movprod.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/statistics/movprod.m Tue Dec 10 12:19:09 2019 -0800 @@ -49,9 +49,9 @@ ## ## The optional string argument @qcode{"@var{nancond}"} controls whether ## @code{NaN} and @code{NA} values should be included (@qcode{"includenan"}), -## or excluded (@qcode{"omitnan"}), from the data passed to @code{movprod}. The -## default is @qcode{"includenan"}. Caution: the @qcode{"omitnan"} option is -## not yet implemented. +## or excluded (@qcode{"omitnan"}), from the data passed to @code{movprod}. +## The default is @qcode{"includenan"}. Caution: the @qcode{"omitnan"} +## option is not yet implemented. ## ## The calculation can be controlled by specifying @var{property}/@var{value} ## pairs. Valid properties are @@ -85,8 +85,8 @@ ## @code{@var{y}(1) = movprod ([NaN, @var{x}(1:2)])}, and ## @code{@var{y}(end) = movprod ([@var{x}(end-1:end), NaN])}. ## This option usually results in @var{y} having @code{NaN} values at the -## boundaries, although it is influenced by how @code{movprod} handles @code{NaN}, -## and also by the property @qcode{"nancond"}. +## boundaries, although it is influenced by how @code{movprod} handles +## @code{NaN}, and also by the property @qcode{"nancond"}. ## ## @item @var{user_value} ## Any window elements outside the data array are replaced by the specified
--- a/scripts/statistics/movstd.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/statistics/movstd.m Tue Dec 10 12:19:09 2019 -0800 @@ -100,8 +100,8 @@ ## @code{@var{y}(1) = movstd ([NaN, @var{x}(1:2)])}, and ## @code{@var{y}(end) = movstd ([@var{x}(end-1:end), NaN])}. ## This option usually results in @var{y} having @code{NaN} values at the -## boundaries, although it is influenced by how @code{movstd} handles @code{NaN}, -## and also by the property @qcode{"nancond"}. +## boundaries, although it is influenced by how @code{movstd} handles +## @code{NaN}, and also by the property @qcode{"nancond"}. ## ## @item @var{user_value} ## Any window elements outside the data array are replaced by the specified
--- a/scripts/statistics/movsum.m Tue Dec 10 11:38:55 2019 +0100 +++ b/scripts/statistics/movsum.m Tue Dec 10 12:19:09 2019 -0800 @@ -85,8 +85,8 @@ ## @code{@var{y}(1) = movsum ([NaN, @var{x}(1:2)])}, and ## @code{@var{y}(end) = movsum ([@var{x}(end-1:end), NaN])}. ## This option usually results in @var{y} having @code{NaN} values at the -## boundaries, although it is influenced by how @code{movsum} handles @code{NaN}, -## and also by the property @qcode{"nancond"}. +## boundaries, although it is influenced by how @code{movsum} handles +## @code{NaN}, and also by the property @qcode{"nancond"}. ## ## @item @var{user_value} ## Any window elements outside the data array are replaced by the specified