Mercurial > hg > octave-nkf
changeset 14853:72b8b39e12be
doc: Periodic grammarcheck of documentation.
* contrib.txi, diagperm.txi, emacs.txi, install.txi, package.txi, plot.txi,
poly.txi, vectorize.txi, strread.m, textscan.m, graphics_toolkit.m, bicg.m,
bicgstab.m, cgs.m, rand.cc, data.cc: Periodic grammarcheck of documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 09 Jul 2012 10:34:43 -0700 |
parents | 53d2c3598d33 |
children | 5ae9f0f77635 |
files | doc/interpreter/contrib.txi doc/interpreter/diagperm.txi doc/interpreter/emacs.txi doc/interpreter/install.txi doc/interpreter/package.txi doc/interpreter/plot.txi doc/interpreter/poly.txi doc/interpreter/vectorize.txi scripts/io/strread.m scripts/io/textscan.m scripts/plot/graphics_toolkit.m scripts/sparse/bicg.m scripts/sparse/bicgstab.m scripts/sparse/cgs.m src/DLD-FUNCTIONS/rand.cc src/data.cc |
diffstat | 16 files changed, 68 insertions(+), 45 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/contrib.txi +++ b/doc/interpreter/contrib.txi @@ -66,28 +66,35 @@ @itemize @bullet @item Check out a copy of the Octave sources: + @example hg clone http://hg.savannah.gnu.org/hgweb/octave @end example @item Change to the top-level directory of the newly checked out sources: + @example cd octave @end example @item Generate the necessary configuration files: + @example ./autogen.sh @end example @item Create a build directory and change to it: + @example +@group mkdir build cd build +@end group @end example + By using a separate build directory, you will keep the source directory clean and it will be easy to completely remove all files generated by the build. You can also have parallel build trees for different @@ -98,15 +105,18 @@ @item Run Octave's configure script from the build directory: + @example ../configure @end example @item Run make in the build directory: + @example make @end example + @end itemize Once the build is finished, you will see a message like the following:
--- a/doc/interpreter/diagperm.txi +++ b/doc/interpreter/diagperm.txi @@ -511,6 +511,7 @@ This behavior not only facilitates the most straightforward and efficient implementation of algorithms, but also preserves certain useful invariants, like: + @itemize @item scalar * diagonal matrix is a diagonal matrix
--- a/doc/interpreter/emacs.txi +++ b/doc/interpreter/emacs.txi @@ -329,6 +329,7 @@ @end table If Font Lock mode is enabled, Octave mode will display + @itemize @bullet @item strings in @code{font-lock-string-face} @@ -436,6 +437,7 @@ The effect of the commands which send code to the Octave process can be customized by the following variables. + @table @code @item octave-send-echo-input Non-@code{nil} means echo input sent to the inferior Octave process.
--- a/doc/interpreter/install.txi +++ b/doc/interpreter/install.txi @@ -74,7 +74,7 @@ @subsection Obtaining the Dependencies Automatically On some systems you can obtain many of Octave's build dependencies -automatically. The commands for doing this vary by system. Similarly, +automatically. The commands for doing this vary by system. Similarly, the names of pre-compiled packages vary by system and do not always match exactly the names listed in @ref{Build Tools} and @ref{External Packages}. @@ -182,8 +182,10 @@ (@url{http://www.netlib.org/blas}). Accelerated BLAS libraries such as ATLAS (@url{http://math-atlas.sourceforge.net}) are recommeded for better performance. + @item LAPACK Linear Algebra Package (@url{http://www.netlib.org/lapack}). + @item PCRE The Perl Compatible Regular Expression library (http://www.pcre.org). @end table @@ -249,7 +251,7 @@ @code{load} and @code{save} commands to read and write HDF data files. @item OpenGL -API for portable 2D and 3D graphics (@url{http://www.opengl.org}). An +API for portable 2-D and 3-D graphics (@url{http://www.opengl.org}). An OpenGL implementation is required to provide Octave's OpenGL-based graphics functions. Octave's OpenGL-based graphics functions usually outperform the gnuplot-based graphics functions because plot data can be @@ -277,7 +279,7 @@ @item zlib Data compression library (@url{http://zlib.net}). The zlib library is required for Octave's @code{load} and @code{save} commands to handle -compressed data, including @sc{Matlab} v5 MAT files. +compressed data, including @sc{matlab} v5 MAT files. @end table @node Running Configure and Make
--- a/doc/interpreter/package.txi +++ b/doc/interpreter/package.txi @@ -181,7 +181,6 @@ following be referred to as @code{package} and may contain the following files: -@noindent @table @code @item package/COPYING This is a required file containing the license of the package. No @@ -260,7 +259,6 @@ Besides the above mentioned files, a package can also contain on or more of the following directories: -@noindent @table @code @item package/inst An optional directory containing any files that are directly installed @@ -305,7 +303,6 @@ package, such as its name, author, and version. This file has a very simple format -@noindent @itemize @item Lines starting with @samp{#} are comments. @@ -340,7 +337,6 @@ The package manager currently recognizes the following keywords -@noindent @table @code @item Name Name of the package. @@ -441,7 +437,6 @@ The optional @file{INDEX} file provides a categorical view of the functions in the package. This file has a very simple format -@noindent @itemize @item Lines beginning with @samp{#} are comments.
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -844,7 +844,7 @@ @end example @noindent -prints the current figure to a color PostScript printer. And, +prints the current figure to a color PostScript printer. And, @example print -deps foo.eps @@ -1180,6 +1180,7 @@ @cindex root figure properties The @code{root figure} properties are: + @table @code @item __modified__ --- Values: "on," "off" @@ -1252,6 +1253,7 @@ @cindex figure properties The @code{figure} properties are: + @table @code @item __graphics_toolkit__ --- The graphics toolkit currently in use. @@ -1335,6 +1337,7 @@ respectively. The functions are called with two input arguments. The first argument holds the handle of the calling figure. The second argument holds the event structure which has the following members: + @table @code @item Character The ASCII value of the key @@ -1356,6 +1359,7 @@ @item nextplot May be one of + @table @code @item "new" @@ -1451,6 +1455,7 @@ @cindex axes properties The @code{axes} properties are: + @table @code @item __modified__ @@ -1580,6 +1585,7 @@ @item nextplot May be one of + @table @code @item "new" @@ -1796,6 +1802,7 @@ @cindex line properties The @code{line} properties are: + @table @code @item __modified__ @@ -1907,6 +1914,7 @@ @cindex text properties The @code{text} properties are: + @table @code @item __modified__ @@ -2024,6 +2032,7 @@ @cindex image properties The @code{image} properties are: + @table @code @item __modified__ @@ -2100,6 +2109,7 @@ @cindex patch properties The @code{patch} properties are: + @table @code @item __modified__ @@ -2248,6 +2258,7 @@ @cindex surface properties The @code{surface} properties are: + @table @code @item __modified__ @@ -2523,6 +2534,7 @@ @table @code @item linestyle May be one of + @table @code @item "-" Solid line. [default] @@ -2551,6 +2563,7 @@ @cindex marker styles, graphics Marker styles are specified by the following properties: + @table @code @item marker A character indicating a plot marker to be place at each data point, or
--- a/doc/interpreter/poly.txi +++ b/doc/interpreter/poly.txi @@ -149,7 +149,7 @@ The number of @var{breaks} (or knots) used to construct the piecewise polynomial is a significant factor in suppressing the noise present in -the input data, @var{x} and @var{y}. This is demostrated by the example +the input data, @var{x} and @var{y}. This is demonstrated by the example below. @example @@ -179,18 +179,17 @@ @float Figure,fig:splinefit1 @center @image{splinefit1,4in} @caption{Comparison of a fitting a piecewise polynomial with 41 breaks to one -with 11 breaks. The fit with the large number of breaks exhibits a fast ripple +with 11 breaks. The fit with the large number of breaks exhibits a fast ripple that is not present in the underlying function.} @end float @end ifnotinfo -The piece-wise polynomial fit, provided by @code{splinefit}, has -continuous derivatives up to the @var{order}-1. For example, a cubic fit -has continuous first and second derivatives. This is demonstrated by +The piecewise polynomial fit, provided by @code{splinefit}, has +continuous derivatives up to the @var{order}-1. For example, a cubic fit +has continuous first and second derivatives. This is demonstrated by the code @example -@group ## Data (200 points) x = 2 * pi * rand (1, 200); y = sin (x) + sin (2 * x) + 0.1 * randn (size (x)); @@ -215,7 +214,6 @@ axis tight ylim auto legend (@{"data", "order 0", "order 1", "order 2", "order 3", "order 4"@}) -@end group @end example @ifnotinfo @@ -225,7 +223,7 @@ @float Figure,fig:splinefit2 @center @image{splinefit2,4in} @caption{Comparison of a piecewise constant, linear, quadratic, cubic, and -quartic polynomials with 8 breaks to noisy data. The higher order solutions +quartic polynomials with 8 breaks to noisy data. The higher order solutions more accurately represent the underlying function, but come with the expense of computational complexity.} @end float @@ -266,12 +264,11 @@ @end float @end ifnotinfo -More complex constraints may be added as well. For example, the code below -illustrates a periodic fit with values that have been clamped at the end points, -and a second periodic fit which is hinged at the end points. +More complex constraints may be added as well. For example, the code below +illustrates a periodic fit with values that have been clamped at the endpoints, +and a second periodic fit which is hinged at the endpoints. @example -@group ## Data (200 points) x = 2 * pi * rand (1, 200); y = sin (2 * x) + 0.1 * randn (size (x)); @@ -293,7 +290,6 @@ axis tight ylim auto legend (@{"data", "clamped", "hinged periodic"@}) -@end group @end example @ifnotinfo @@ -303,7 +299,7 @@ @float Figure,fig:splinefit4 @center @image{splinefit4,4in} @caption{Comparison of two periodic piecewise cubic fits to a noisy periodic -signal. One fit has its end points clamped and the second has its end points +signal. One fit has its endpoints clamped and the second has its endpoints hinged.} @end float @end ifnotinfo @@ -314,7 +310,6 @@ suppression and a third illustrating the non-robust solution. @example -@group ## Data x = linspace (0, 2*pi, 200); y = sin (x) + sin (2 * x) + 0.05 * randn (size (x)); @@ -339,7 +334,6 @@ "robust, beta = 0.75", "no robust fitting"@}) axis tight ylim auto -@end group @end example @ifnotinfo @@ -348,7 +342,7 @@ @float Figure,fig:splinefit6 @center @image{splinefit6,4in} -@caption{Comparison of two different levels of robust fitting (@var{beta} = 0.25 and 0.75) to noisy data combined with outlying data. A conventional fit, without +@caption{Comparison of two different levels of robust fitting (@var{beta} = 0.25 and 0.75) to noisy data combined with outlying data. A conventional fit, without robust fitting (@var{beta} = 0) is also included.} @end float @end ifnotinfo
--- a/doc/interpreter/vectorize.txi +++ b/doc/interpreter/vectorize.txi @@ -191,6 +191,7 @@ @item Repetition + @itemize @item repmat @@ -201,6 +202,7 @@ @item Vectorized arithmetic + @itemize @item sum @@ -232,6 +234,7 @@ @item Shape of higher dimensional arrays + @itemize @item reshape @@ -342,8 +345,8 @@ subtraction takes place. A special case of broadcasting that may be familiar is when all -dimensions of the array being broadcast are 1, i.e. the array is a -scalar. Thus for example, operations like @code{x - 42} and @code{max +dimensions of the array being broadcast are 1, i.e., the array is a +scalar. Thus for example, operations like @code{x - 42} and @code{max (x, 2)} are basic examples of broadcasting. For a higher-dimensional example, suppose @code{img} is an RGB image of
--- a/scripts/io/strread.m +++ b/scripts/io/strread.m @@ -168,7 +168,7 @@ ## ## @end table ## -# @seealso{textscan, textread, load, dlmread, fscanf} +## @seealso{textscan, textread, load, dlmread, fscanf} ## @end deftypefn function varargout = strread (str, format = "%f", varargin)
--- a/scripts/io/textscan.m +++ b/scripts/io/textscan.m @@ -26,8 +26,8 @@ ## Read data from a text file or string. ## ## The string @var{str} or file associated with @var{fid} is read from and -## parsed according to @var{format}. The function behaves like @code{strread} -## except it can also read from file instead of a string. See the documentation +## parsed according to @var{format}. The function behaves like @code{strread} +## except it can also read from file instead of a string. See the documentation ## of @code{strread} for details. ## ## In addition to the options supported by @code{strread}, this function
--- a/scripts/plot/graphics_toolkit.m +++ b/scripts/plot/graphics_toolkit.m @@ -17,17 +17,17 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{name} =} graphics_toolkit () -## Returns the default graphics toolkit. The default graphics toolkit value +## @deftypefn {Function File} {@var{name} =} graphics_toolkit () +## Return the default graphics toolkit. The default graphics toolkit value ## is assigned to new figures. ## @deftypefnx {Function File} {@var{name} =} graphics_toolkit (@var{hlist}) -## Returns the graphics toolkits for the figures with handles @var{hlist}. +## Return the graphics toolkits for the figures with handles @var{hlist}. ## @deftypefnx {Function File} {} graphics_toolkit (@var{name}) -## Sets the default graphics toolkit to @var{name}. If the toolkit is not +## Set the default graphics toolkit to @var{name}. If the toolkit is not ## already loaded, it is initialized by calling the function ## @code{__init_@var{name}__}. ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name}) -## Sets the graphics toolkit for the figures with handles @var{hlist} to +## Set the graphics toolkit for the figures with handles @var{hlist} to ## @var{name}. ## @seealso{available_graphics_toolkits} ## @end deftypefn
--- a/scripts/sparse/bicg.m +++ b/scripts/sparse/bicg.m @@ -46,6 +46,7 @@ ## ## @itemize @minus ## @item @var{flag} indicates the exit status: +## ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance ##
--- a/scripts/sparse/bicgstab.m +++ b/scripts/sparse/bicgstab.m @@ -48,6 +48,7 @@ ## ## @itemize @minus ## @item @var{flag} indicates the exit status: +## ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance ##
--- a/scripts/sparse/cgs.m +++ b/scripts/sparse/cgs.m @@ -48,6 +48,7 @@ ## ## @itemize @minus ## @item @var{flag} indicates the exit status: +## ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance ##
--- a/src/DLD-FUNCTIONS/rand.cc +++ b/src/DLD-FUNCTIONS/rand.cc @@ -448,7 +448,7 @@ using the \"reset\" keyword.\n\ \n\ The class of the value returned can be controlled by a trailing \"double\"\n\ -or \"single\" argument. These are the only valid classes.\n\ +or \"single\" argument. These are the only valid classes.\n\ @seealso{randn, rande, randg, randp}\n\ @end deftypefn") { @@ -556,7 +556,7 @@ to transform from a uniform to a normal distribution.\n\ \n\ The class of the value returned can be controlled by a trailing \"double\"\n\ -or \"single\" argument. These are the only valid classes.\n\ +or \"single\" argument. These are the only valid classes.\n\ \n\ Reference: G. Marsaglia and W.W. Tsang,\n\ @cite{Ziggurat Method for Generating Random Variables},\n\ @@ -626,7 +626,7 @@ to transform from a uniform to an exponential distribution.\n\ \n\ The class of the value returned can be controlled by a trailing \"double\"\n\ -or \"single\" argument. These are the only valid classes.\n\ +or \"single\" argument. These are the only valid classes.\n\ \n\ Reference: G. Marsaglia and W.W. Tsang,\n\ @cite{Ziggurat Method for Generating Random Variables},\n\ @@ -772,7 +772,7 @@ @end table\n\ \n\ The class of the value returned can be controlled by a trailing \"double\"\n\ -or \"single\" argument. These are the only valid classes.\n\ +or \"single\" argument. These are the only valid classes.\n\ @seealso{rand, randn, rande, randp}\n\ @end deftypefn") { @@ -994,7 +994,7 @@ @end table\n\ \n\ The class of the value returned can be controlled by a trailing \"double\"\n\ -or \"single\" argument. These are the only valid classes.\n\ +or \"single\" argument. These are the only valid classes.\n\ @seealso{rand, randn, rande, randg}\n\ @end deftypefn") { @@ -1105,7 +1105,7 @@ replacement from @code{1:@var{n}}. The complexity is O(@var{n}) in\n\ memory and O(@var{m}) in time, unless @var{m} < @var{n}/5, in which case\n\ O(@var{m}) memory is used as well. The randomization is performed using\n\ -rand(). All permutations are equally likely.\n\ +rand(). All permutations are equally likely.\n\ @seealso{perms}\n\ @end deftypefn") {
--- a/src/data.cc +++ b/src/data.cc @@ -5648,7 +5648,7 @@ DEFUN (tic, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} tic ()\n\ -@deftypefnx {Built-in Function} {@var{id} =} tic ()\n\ +@deftypefnx {Built-in Function} {@var{id} =} tic ()\n\ @deftypefnx {Built-in Function} {} toc ()\n\ @deftypefnx {Built-in Function} {} toc (@var{id})\n\ @deftypefnx {Built-in Function} {@var{val} =} toc (@dots{})\n\ @@ -5715,9 +5715,9 @@ DEFUN (toc, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} toc ()\n\ +@deftypefn {Built-in Function} {} toc ()\n\ @deftypefnx {Built-in Function} {} toc (@var{id})\n\ -@deftypefnx {Built-in Function} {@var{val} = } toc (@dots{})\n\ +@deftypefnx {Built-in Function} {@var{val} =} toc (@dots{})\n\ See tic.\n\ @end deftypefn") {