Mercurial > octave
changeset 13931:9de488c6c59c
doc: Spellcheck documentation before 3.6.0 release
* aspell-octave.en.pws: Add new words to dictionary.
* debug.txi, plot.txi, accumarray.m, krylov.m, sqp.m, pkg.m, fftshift.m,
bicg.m, binornd.m, str2num.m: Correct misspellings or add @nospell macro.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Wed, 23 Nov 2011 09:42:50 -0800 |
| parents | fe088cef3503 |
| children | 6ead4dc1ca55 |
| files | doc/interpreter/debug.txi doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/plot.txi scripts/general/accumarray.m scripts/linear-algebra/krylov.m scripts/optimization/sqp.m scripts/pkg/pkg.m scripts/signal/fftshift.m scripts/sparse/bicg.m scripts/statistics/distributions/binornd.m scripts/strings/str2num.m |
| diffstat | 11 files changed, 64 insertions(+), 37 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/debug.txi Wed Nov 23 08:44:29 2011 -0800 +++ b/doc/interpreter/debug.txi Wed Nov 23 09:42:50 2011 -0800 @@ -194,7 +194,7 @@ profiling is enabled, each call to a function (supporting built-ins, operators, functions in oct- and mex-files, user-defined functions in Octave code and anonymous functions) is recorded while running Octave -code. After that, this data can aid in analyzing the code behaviour, and +code. After that, this data can aid in analyzing the code behavior, and is in particular helpful for finding ``hot spots'' in the code which use up a lot of computation time and are the best targets to spend optimization efforts on. @@ -221,7 +221,7 @@ @end group @end example -This shows that most of the runtime was spent executing the function +This shows that most of the run time was spent executing the function @samp{myfib}, and some minor proportion evaluating the listed binary operators. Furthermore, it is shown how often the function was called and the profiler also records that it is recursive. @@ -334,7 +334,7 @@ once. The second expensive operation is the matrix-vector product in the routine @code{timesteps}. @footnote{We only know it is the binary multiplication operator, but fortunately this operator appears only at -one place in the code and thus we know which occurence takes so much +one place in the code and thus we know which occurrence takes so much time. If there were multiple places, we would have to use the hierarchical profile to find out the exact place which uses up the time which is not covered in this example.} @@ -405,7 +405,7 @@ suboptimal way, and most of the time was spent in @code{bar} itself. Finally, let's say we want to profile the execution of both @code{foo} -and @code{bar} together. Since we already have the runtime data +and @code{bar} together. Since we already have the run-time data collected for @code{bar}, we can restart the profiler without clearing the existing data and collect the missing statistics about @code{foo}. This is done by:
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Wed Nov 23 08:44:29 2011 -0800 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Wed Nov 23 09:42:50 2011 -0800 @@ -1,11 +1,12 @@ personal_ws-1.1 en 1 Abramowitz accumarray +Acknowledgements acknowledgements -Acknowledgements ACM adams Affero +afterwards Ahalt aifm AIX @@ -15,8 +16,8 @@ alnum alphanum amd +ANOVA anova -ANOVA Anymap API approximant @@ -32,14 +33,15 @@ Autoconf autocorrelations autocovariances +autoload Autoload -autoload autoloaded autoloading Autoloading autoregression autoregressions autoscaled +AutoScaling AWK backend Backends @@ -104,6 +106,7 @@ ceil cellstr ChangeLog +changelogs changeset changesets Chaves @@ -128,12 +131,14 @@ cof coffset colamd +collectoutput colorbar colormap colperm Comint Commandline commentstyle +ComplexEqn cond condest conformant @@ -151,6 +156,7 @@ cov CPLEX CreateFcn +CRLF csymamd ctranspose CTRL @@ -167,6 +173,8 @@ dataset datasets datasource +datestr +datestrings davis ddd dddd @@ -175,8 +183,8 @@ deallocated deconv deftypefn +Delaunay delaunay -Delaunay delaunayn DeleteFcn delim @@ -225,9 +233,11 @@ endian Endian endif +endofline Engle's eof EOF +EOLs EOS eps eq @@ -257,8 +267,9 @@ facevertexcdata fcdf femmodel +FFF +FFT fft -FFT fftn fftpack FFTs @@ -269,6 +280,7 @@ filename filenames Filesystem +FinDiffType finv FIRfilter FIXME @@ -292,6 +304,7 @@ Frobenius Fs FSF +FunValCheck gamcdf gaminv gampdf @@ -319,17 +332,18 @@ globbing glpk GLS +gnuplot Gnuplot -gnuplot gnuplot's Golub Gonnet +goto Goto -goto gotos GPL gplot grabdemo +GradObj GraphicsMagick Graymap grayscale @@ -377,8 +391,8 @@ hygepdf hygernd Hyndman +Hypergeometric hypergeometric -Hypergeometric IEEE iff ifft @@ -446,13 +460,14 @@ ldivide ldots le +Leftarrow leftarrow -Leftarrow Leftrightarrow leftrightarrow Lehoucq leq Levinson +LF lfloor li libcruft @@ -463,12 +478,13 @@ lineanchors linefeeds linesearch +linespec linespoints linkprop literalspacing Liu +LM lm -LM loadpath Lobatto logit @@ -506,8 +522,10 @@ matchcase matlab Matsumoto +MaxFunEvals maxima MaxIntervalCount +MaxIter mcnemar McNemar's meansq @@ -515,8 +533,8 @@ Mersenne meshgrid meshgridded +metafile Metafile -metafile metafiles Metafont mex @@ -548,6 +566,7 @@ multi multibyte multiline +multipledelimsasone MultiSelect mxArray myclass @@ -590,6 +609,7 @@ noscal noshare notin +nthargout NTSC nul Nx @@ -626,8 +646,8 @@ PCRE PCX pcx +pdf PDF -pdf periodogram perp Petzold's @@ -661,6 +681,8 @@ presolver printf priori +Profiler +profiler propto proven ps @@ -677,15 +699,15 @@ qhull QP QQ +qrupdate QRUPDATE -qrupdate quadcc quadgk quadl quadpack quadv +quantile Quantile -quantile quantiles Quickhull qz @@ -718,6 +740,7 @@ resnorm resparsify RET +returnonerror rfloor RGB Riccati @@ -791,9 +814,10 @@ Stadlober stairstep Stallman +startup Startup -startup stdnormal +stdout Stegun Stepleman stepsize @@ -812,8 +836,8 @@ subexpressions subfunction Subfunction +subfunctions Subfunctions -subfunctions subinterval Subintervals subintervals @@ -826,8 +850,8 @@ subprocesses Subprocesses subsasgn +Subscripted subscripted -Subscripted subscripting subseteq subsindex @@ -857,8 +881,9 @@ Tcv terminal's tex +texinfo Texinfo -texinfo +textscan th ths tif @@ -878,6 +903,7 @@ tpdf traceback trapz +treatasempty treelayout treeplot tridiagonal @@ -888,6 +914,7 @@ Tx txi typedefs +TypicalX ub UB uchar @@ -955,16 +982,16 @@ wblpdf wblrnd Weibull +Welch welch -Welch WestOutside whitespace Whitespace whos wienrnd Wikipedia +wilcoxon Wilcoxon -wilcoxon wildcard Wildcards wildcards @@ -1000,10 +1027,10 @@ ydata yerrorbar yerrorbars +yy YY -yy +yyyy YYYY -yyyy yyyymmdd yyyymmddTHHMMSS Zechner
--- a/doc/interpreter/plot.txi Wed Nov 23 08:44:29 2011 -0800 +++ b/doc/interpreter/plot.txi Wed Nov 23 09:42:50 2011 -0800 @@ -2397,7 +2397,7 @@ Although default values may be set for any object, they are set in parent objects and apply to child objects, of the specified object type. -For example, seeting the default @code{color} property of @code{line} +For example, setting the default @code{color} property of @code{line} objects to "green", for the @code{root} object, will result in all @code{line} objects inheriting the @code{color} "green" as the default value.
--- a/scripts/general/accumarray.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/general/accumarray.m Wed Nov 23 09:42:50 2011 -0800 @@ -43,13 +43,13 @@ ## ## The elements of the returned array that have no subscripts associated ## with them are set to zero. Defining @var{fillval} to some other value -## allows these values to be defined. This behaviour changes, however, +## allows these values to be defined. This behavior changes, however, ## for certain values of @var{func}. If @var{func} is @code{min} ## (respectively, @code{max}) then the result will be filled with the ## minimum (respectively, maximum) integer if @var{vals} is of integral ## type, logical false (respectively, logical true) if @var{vals} is of ## logical type, zero if @var{fillval} is zero and all values are -## nonpositive (respectively, non-negative), and NaN otherwise. +## non-positive (respectively, non-negative), and NaN otherwise. ## ## By default @code{accumarray} returns a full matrix. If ## @var{issparse} is logically true, then a sparse matrix is returned
--- a/scripts/linear-algebra/krylov.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/linear-algebra/krylov.m Wed Nov 23 09:42:50 2011 -0800 @@ -28,8 +28,8 @@ ## Using Householder reflections to guard against loss of orthogonality. ## ## If @var{V} is a vector, then @var{h} contains the Hessenberg matrix -## such that @xcode{a*u == u*h+rk*ek'}, in which @code{rk = -## a*u(:,k)-u*h(:,k)}, and @xcode{ek'} is the vector +## such that @nospell{@xcode{a*u == u*h+rk*ek'}}, in which @code{rk = +## a*u(:,k)-u*h(:,k)}, and @nospell{@xcode{ek'}} is the vector ## @code{[0, 0, @dots{}, 1]} of length @code{k}. Otherwise, @var{h} is ## meaningless. ##
--- a/scripts/optimization/sqp.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/optimization/sqp.m Wed Nov 23 09:42:50 2011 -0800 @@ -75,7 +75,7 @@ ## formula is used to approximate the Hessian. ## ## When supplied, the gradient function @code{@var{phi}@{2@}} must accept -## one vector argument and return a vector. When supplifed, the Hessian +## one vector argument and return a vector. When supplied, the Hessian ## function @code{@var{phi}@{3@}} must accept one vector argument and ## return a matrix. ##
--- a/scripts/pkg/pkg.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/pkg/pkg.m Wed Nov 23 09:42:50 2011 -0800 @@ -72,7 +72,7 @@ ## @end table ## ## @item update -## Check installed Octave-Forge pacakages against repository and update any +## Check installed Octave-Forge packages against repository and update any ## outdated items. This requires an internet connection and the cURL library. ## Usage: ##
--- a/scripts/signal/fftshift.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/signal/fftshift.m Wed Nov 23 09:42:50 2011 -0800 @@ -32,7 +32,7 @@ ## @end example ## ## @noindent -## where @math{df} = 1 / @math{dt}. +## where @nospell{@math{df}} = 1 / @math{dt}. ## ## If @var{x} is a matrix, the same holds for rows and columns. If ## @var{x} is an array, then the same holds along each dimension.
--- a/scripts/sparse/bicg.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/sparse/bicg.m Wed Nov 23 09:42:50 2011 -0800 @@ -43,7 +43,7 @@ ## @code{g(x, 'notransp') = M1 \ x} or @code{g(x, 'notransp') = M2 \ x} and ## @code{g(x, 'transp') = M1' \ x} or @code{g(x, 'transp') = M2' \ x}. ## -## If colled with more than one output parameter +## If called with more than one output parameter ## ## @itemize @minus ## @item @var{flag} indicates the exit status:
--- a/scripts/statistics/distributions/binornd.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/statistics/distributions/binornd.m Wed Nov 23 09:42:50 2011 -0800 @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, @var{r}) ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, @var{r}, @var{c}, @dots{}) ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, [@var{sz}]) -## Return a matrix of random samples from the binonmial distribution with +## Return a matrix of random samples from the binomial distribution with ## parameters @var{n} and @var{p}. ## ## When called with a single size argument, return a square matrix with
--- a/scripts/strings/str2num.m Wed Nov 23 08:44:29 2011 -0800 +++ b/scripts/strings/str2num.m Wed Nov 23 09:42:50 2011 -0800 @@ -35,7 +35,7 @@ ## @end example ## ## The optional second output, @var{state}, is logically true when the -## coversion is successful. If the conversion fails the numeric output, +## conversion is successful. If the conversion fails the numeric output, ## @var{x}, is empty and @var{state} is false. ## ## @strong{Caution:} As @code{str2num} uses the @code{eval} function