Mercurial > hg > octave-shane
changeset 11575:d6619410e79c
Spellcheck documentation before 3.4 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 19 Jan 2011 21:16:13 -0800 |
parents | a83bad07f7e3 |
children | 8ac9687dbe9f |
files | doc/ChangeLog doc/interpreter/doccheck/aspell-octave.en.pws scripts/ChangeLog scripts/general/curl.m scripts/general/divergence.m scripts/io/strread.m scripts/miscellaneous/mkoctfile.m scripts/plot/bar.m scripts/plot/errorbar.m scripts/plot/hist.m scripts/plot/mesh.m scripts/plot/surf.m scripts/polynomial/polyaffine.m src/ChangeLog src/data.cc src/input.cc src/utils.cc |
diffstat | 17 files changed, 421 insertions(+), 324 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2011-01-19 Rik <octave@nomad.inbox5.com> + + * interpreter/doccheck/aspell-octave.en.pws: Add new words to Octave + private dictionary. + 2011-01-19 Rik <octave@nomad.inbox5.com> * doc/interpreter/diagperm.txi, doc/interpreter/dynamic.txi,
--- a/doc/interpreter/doccheck/aspell-octave.en.pws +++ b/doc/interpreter/doccheck/aspell-octave.en.pws @@ -1,337 +1,71 @@ personal_ws-1.1 en 1 +Abramowitz +accumarray +acknowledgements +Acknowledgements ACM -AIX -ANOVA -API -ARMA -AWK -Abramowitz -Acknowledgements +adams Affero Ahalt +aifm +AIX +al Alamos +aleph +amd +anova +ANOVA +Anymap +API +approximant +ARMA +arpack Ashok +async +atan Attr AutoCAD Autoconf -Autoload -Autoloading -BDF -BFGS -BV -BZ -Backends -Bateman -Bilbert -Biomathematics -Blackman -Brenan -Brockwell -ButtonDownFcn -CCR -CCS -CDF -CDFs -CMatrix -CPLEX -CTS -CallbackObject -ChangeLog -Chaves -Cholesky -Comint -Commandline -Corel -CorelDraw -CreateFcn -Cuthill -Cygwin -DAE -DMS -Delaunay -DeleteFcn -Demmel -DeskJet -Dn -Dobkin -Downarrow -Driebeck -Dt -Dulmage -Durbin -EIDORS -EOF -EOS -EastOutside -Ekerdt -Elfers -Endian -Engle's -ErrorHandler -Errorbar -Errorbars -Esmond -Executables -FFT -FFTs -FG -FIRfilter -FIXME -FSF -Filesystem -FlashPix -Fortran -FreeBSD -Frobenius -GECOS -GEP -GIF -GLS -GPL -Gautschi -Ghostscript -Gnuplot -Golub -Goto -Graz -HDF -HH -HSV -Hackbusch -Hadamard -Haddad -Hankel -Hanning -Hauberg -Helvetica -Hermitian -Hessenberg -Higham -Hindmarsh -Hindmarsh's -Hodel -Horner's -Hotelling's -Hudak -Huhdanpaa -Hyndman -Hypergeometric -IEEE -IIP -Im -Imenu -Indices -Inline -JPEG -Jacobian -Kolmogorov -Konrod -Krishnamurthy -Kruskal -Krylov -LM -LabelSpacing -Lanzcos -Larimore -LaserJet -Leftarrow -Leftrightarrow -Lehoucq -Levinson -Liu -Lobatto -Lookup -Los -Lovato -Lua -MANOVA -MIP -MMM -Magnus -Mahalanobis -Mandriva -Marsaglia -Maschhoff -Matsumoto -MaxIntervalCount -McNemar's -Mendelsohn -Mersenne -Metafile -Metafont -Michelsen -Microsystems -Minitab -Misra -Moler -Montanet -Multi -MxN -MxNx -NLP -NTSC -NaN -NaNs -NeXT -Neudecker -Neumann -Ng -Nishimura -NorthOutside -Nx -OLS -OpenGL -Oppenheim -OutputFcn -PBM -PBMplus -PCG -PCX -PDF -PHP -PNG -POSIX -PWS -Petzold's -PointJet -PostScript -Pothen -Prepend -Pseudospectra -QP -QQ -QZ -Qci -Qhull -Quantile -Quickhull -RET -RGB -RMS -RPMs -Rajamanickam -Rawlings -Readline -Reindent -Resize -Riccati -Rightarrow -Rosser -Rossum -SAS -SCO -SIGNUM -SIMAX -SPARSKIT -SPSS -STFT -STL -SV -SVD -SVG -SYMAMD -Saad -Sandia -Schafer -Schur -Sep -Shampine -Smirnov -Sorensen -SouthOutside -Spearman's -Stadlober -Stallman -Startup -Stegun -Stepleman -Subfunction -Subfunctions -Sublicensing -Subprocesses -Subscripted -SunOS -SwitzerlandLight -Sym -Tcv -Texinfo -TikZ -Tikhonov -Tisseur -Tisseur's -Toeplitz -TolF -TolFun -TolX -Tsang -UB -UID -Ultrix -Unary -Uncomments -UniformOutput -Uninstall -Uparrow -Username -Vandermonde -Vectorize -Villadsen -Voronoi -WIPO -Weibull -Welch -WestOutside -Whitespace -Wikipedia -Wilcoxon -Wildcards -Wilks -WinRand -XFig -YY -YYYY -Zechner -Ziggurat -accumarray -acknowledgements -adams -aifm -al -aleph -amd -anova -arpack -async -atan autocorrelations autocovariances +Autoload autoload autoloaded autoloading +Autoloading autoregression autoregressions autoscaled +AWK backend +Backends backends bartlett +Bateman +BDF bdf betacdf betainv betapdf betarnd +BFGS bigtriangledown +Bilbert bincoeff binocdf binoinv binopdf binornd +Biomathematics bitmax bitwise bivariate +Blackman blas +bmp bof +boolean boolMatrix -boolean boxerrorbars boxoff boxon @@ -339,34 +73,49 @@ bracketx brackety breakpoint +Brenan +Brockwell builtin builtins +ButtonDownFcn +BV bz +BZ bzip -cURL +CallbackObject callee's cauchy caxis ccolamd +CCR +CCS cd cdata +CDF cdf +CDFs cdot ceil cellstr +ChangeLog changeset changesets +Chaves chdir chisq chisquare chol +Cholesky +cholmod cindex circ circshift circum +Clenshaw clim cloglog clubsuit +CMatrix cmd cmember cof @@ -374,6 +123,8 @@ colorbar colormap colperm +Comint +Commandline cond condest conformant @@ -383,14 +134,26 @@ contextless contourc convhull +Corel +CorelDraw corrcoef cosecant courseware cov +CPLEX +CreateFcn csymamd ctranspose -dMatrix -dOmega +CTS +cURL +Cuthill +cxsparse +Cygwin +DAE +DAEs +daspk +dasrt +dassl dataset datasets datasource @@ -403,126 +166,227 @@ deconv deftypefn delaunay +Delaunay delaunayn +DeleteFcn delim demi +Demmel +DeskJet +Deskjet det diag diamondsuit dir disp +dMatrix dmperm +DMS +Dn +Dobkin +dOmega dotall dotexceptnewline +Downarrow downarrow downdate dpi +Driebeck dt +Dt +Dulmage +Durbin dx dy +EastOutside +eE +EIDORS eigenpairs eigenvector eigenvectors eigs +Ekerdt +Elfers elseif emacs +emptyvalue endfunction endian +Endian endif +Engle's eof +EOF +EOS eps eq equidistributed equispaced erf errno +Errorbar errorbar +Errorbars errorbars +ErrorHandler +Esmond et etree etreeplot eval +Executables exitflag expcdf expinv exppdf exprnd extendedtext +fA +facecolor facevertexcdata fcdf femmodel fft +FFT fftn fftpack +FFTs fftw +FG fieldname fieldnames filename filenames +Filesystem finv +FIRfilter +FIXME +FlashPix +fltk +fontconfig fontname forall formfeed +Fortran fpdf fprintf +FreeBSD freespacing +freetype frnd frob +Frobenius +Fs +FSF gamcdf gaminv gampdf gamrnd +Gautschi gcbo +GCC +gcd ge +GECOS genvarname geocdf geoinv geopdf geornd +GEP geq +gesdd +gesvd +gfortan +Ghostscript +gif +GIF glibc globbing +glpk +GLS +Gnuplot gnuplot gnuplot's +Golub +Gonnet +Goto goto gotos +GPL gplot grabdemo +GraphicsMagick +Graymap +grayscale +Graz griddata gswin gunzipped gz gzip gzipped +Hackbusch +Hadamard +Haddad +Hankel +Hanning hardcode +Hauberg +HDF +hdf +headerlines heartsuit +Helvetica +Hermitian +Hessenberg heteroscedascity hggroup hh +HH +Higham +Hindmarsh +Hindmarsh's +Hodel holomorphic +Horner's horzcat hotelling +Hotelling's +HSV +Hudak +Huhdanpaa hygecdf hygeinv hygepdf hygernd +Hyndman hypergeometric +Hypergeometric +IEEE iff ifft ifftn ignorecase +IIP ij +Im imag +Imenu +Indices indices infty init inline +Inline inpolygon interp interpderiv interpft interpn interpolant +Interpolants +interquartile inv ipermute ishandle @@ -533,28 +397,49 @@ isvector ith iy +Jacobian +Jacobians ji +jp +jpeg +JPEG +jpg +jpx keybindings keypress +Kolmogorov kolmogorov +Konrod +Krishnamurthy kron kruskal +Kruskal +Krylov kurtosis +LabelSpacing langle +Lanzcos lapack laplace +Larimore +LaserJet lceil ldiv ldivide ldots le leftarrow +Leftarrow +Leftrightarrow leftrightarrow +Lehoucq leq +Levinson lfloor li libcruft libcurl +liblapack liboctave licensors lineanchors @@ -563,8 +448,11 @@ linespoints linkprop literalspacing +Liu lm +LM loadpath +Lobatto logit logncdf logninv @@ -572,49 +460,82 @@ lognpdf lognrnd lookup +Lookup lookups +Los +Lovato lpx lr lsode lt lu +Lua luinc lvalue lvl lx ly lz +Magnus +Mahalanobis makefile makefiles +Mandriva +MANOVA manova +Marsaglia +Maschhoff matchcase matlab +Matsumoto maxima +MaxIntervalCount mcnemar +McNemar's +meansq +Mendelsohn +Mersenne meshgrid meshgridded +Metafile +metafile metafiles +Metafont mex +Michelsen +Microsystems minima +Minitab minval +MIP +miscompiled +Misra mkoctfile mldivide mmd +MMM mmm mmmm mmmyy mmmyyyy modelled +Moler +Montanet mpoles mpower mrdivide mtimes +Multi multi multibyte multiline mxArray +MxN +MxNx myclass nabla +NaN +NaNs nargin nbincdf nbininv @@ -624,39 +545,77 @@ ndgrid ne neq +Neudecker +Neumann +NeXT nfev +nfft +Ng ni +Nishimura +NLP nnls nnz nocompute +nolabel noncommercially nonzeros +noperm normcdf normest norminv normpdf normrnd +NorthOutside +noscal notin +NTSC nul +Nx nzmax oct octaverc +ODEPACK +OLS +onesided online +OpenGL oplus +Oppenheim oregonator oslash otimes +OutputFcn outputfcn +paperorientation paperposition papersize parseparams +pbm +PBM +PBMplus pcg +PCG pchip pcr +pcre +PCX +pcx +PDF pdf periodogram perp +Petzold's +PGF +pgm +PHP +pict pinv +Pixmap +png +PNG +pnm +PointJet poisscdf poissinv poisspdf @@ -664,10 +623,14 @@ polyderiv polyfit polyval +POSIX postorder +PostScript +Pothen pre preconditioner premultiplied +Prepend prepended presolver printf @@ -678,44 +641,84 @@ pseudoinverse pseudonorm pseudorandom +Pseudospectra ptrace +PWS +Pxx +Qci +Qhull qhull +QP +QQ +QRUPDATE +quadpack +Quantile quantile quantiles +Quickhull qz +QZ radices +Rajamanickam randn randperm rangle +ranlib +ras +Rawlings rceil rdivide +Readline readline recursing +regex regressor +reimported +Reindent relicensing ren repmat resampled resampling +Resize resize resized resnorm resparsify +RET rfloor +RGB +Riccati +Rightarrow rightarrow rline +RMS rnd +Rosser +Rossum +rpath +RPMs rr +sa +Saad +Sandia +SAS sB -sa +Schafer +Schur +SCO screenful se seealso semidefinite +Sep +Shampine shiftdim si signum +SIGNUM sim +SIMAX simplechol simplecholperm simplematrix @@ -723,14 +726,19 @@ sinetone sm smirnov +Smirnov +Sorensen +SouthOutside sp spadesuit spalloc +SPARSKIT spaugment spchol spcholperm spconvert spdiags +Spearman's speye spfun spmatrix @@ -740,14 +748,23 @@ sprandn sprandsym sprank +SPSS spstats sqrt sqrtm sr ss +Stadlober stairstep +Stallman +Startup startup +stdnormal +Stegun +Stepleman stepsize +STFT +STL stochastically strcmp stringanchors @@ -760,38 +777,63 @@ subdirectory subexpressions subfunction +Subfunction +Subfunctions subfunctions subinterval sublicenses +Sublicensing submatrices submatrix subprocess subprocesses +Subprocesses subsasgn subscripted +Subscripted subscripting subseteq subsindex subsref substring substrings +SuiteSparse +SunOS superiorto supradiagonal supset supseteq +SV +SVD svd svds +SVG +svg +SwitzerlandLight +Sym sym +SYMAMD symamd symbfact symrcm tcdf +Tcv terminal's tex +Texinfo th ths +tif +Tikhonov +TikZ tinv +Tisseur +Tisseur's +Toeplitz tokenExtents +TolF +TolFun +TolX tp tpdf traceback @@ -800,16 +842,24 @@ tridiagonal triplot trnd +Tsang tuples +twosided +Tx txi typedefs ub +UB +UID uint +Ultrix umfpack uminus un +Unary unary uncomment +Uncomments unformatted unidcdf unidinv @@ -817,9 +867,11 @@ unidrnd unifcdf unifinv +UniformOutput unifpdf unifrnd unimodal +Uninstall uninstalled univariate unnormalized @@ -827,9 +879,13 @@ unpivoted unshare unsymmetric +untabified uparrow +Uparrow uplus userdata +Username +Vandermonde variable's varphi varpi @@ -837,49 +893,73 @@ vartheta vec vech +Vectorize vectorize vectorizing vee versa vertcat vertices +Villadsen voronoi +Voronoi +Wa wallis wblcdf wblinv wblpdf wblrnd +Weibull welch +Welch +WestOutside whitespace +Whitespace whos wienrnd +Wikipedia +Wilcoxon wilcoxon wildcard +Wildcards wildcards +Wilks +WinRand +WIPO +Wl wp +xb +xcorr +xerrorbar +xerrorbars +XFig xGBTRF xGELSD xGETRF xGTSV +xl +xmin xN xPBTRF xPOTRF xPTSV xTRTRS -xb -xerrorbar -xerrorbars -xl -xmin xu +xwd xy xyerrorbar xyerrorbars +xyz +ydata yerrorbar yerrorbars +YY yy +YYYY yyyy yyyymmdd yyyymmddTHHMMSS +Zechner zer +Ziggurat zlib
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,11 @@ +2011-01-19 Rik <octave@nomad.inbox5.com> + + + * general/curl.m, general/divergence.m, io/strread.m, + miscellaneous/mkoctfile.m, plot/bar.m, plot/errorbar.m, plot/hist.m, + plot/mesh.m, plot/surf.m, polynomial/polyaffine.m: Correct spelling + in docstrings. + 2011-01-19 John W. Eaton <jwe@octave.org> * help/help.m: New option --list. Bug #31905.
--- a/scripts/general/curl.m +++ b/scripts/general/curl.m @@ -44,7 +44,7 @@ ## for two-dimensional input. For three-dimensional input the scalar ## rotation is calculated at each grid point in direction of the vector field ## at that point. -## @seealso{divergence, gradient, del2} +## @seealso{divergence, gradient, del2, cross, dot} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de> @@ -154,4 +154,4 @@ %! [cz,av] = curl(X/2,Y/2,2*(X-Y),Y); %! assert(all(cz(:)==4)); %! assert(all(av(:)==2)); -%! assert(size_equal(X,Y,cz,av)); \ No newline at end of file +%! assert(size_equal(X,Y,cz,av));
--- a/scripts/general/divergence.m +++ b/scripts/general/divergence.m @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {@var{div} =} divergence (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {@var{div} =} divergence (@var{x}, @var{y}, @var{fx}, @var{fy}) ## @deftypefnx {Function File} {@var{div} =} divergence (@var{fx}, @var{fy}) -## Calculate divegence of vector field given by the arrays @var{fx}, +## Calculate divergence of a vector field given by the arrays @var{fx}, ## @var{fy}, and @var{fz} or @var{fx}, @var{fy} respectively. ## @tex ## $$ @@ -42,7 +42,7 @@ ## The coordinates of the vector field can be given by the arguments @var{x}, ## @var{y}, @var{z} or @var{x}, @var{y} respectively. ## -## @seealso{curl, gradient, del2} +## @seealso{curl, gradient, del2, cross, dot} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/io/strread.m +++ b/scripts/io/strread.m @@ -68,7 +68,7 @@ ## [@var{a}, @var{b}, @var{c}] = strread (@var{str}, "%s %s %f"); ## @end example ## -## The behaviour of @code{strread} can be changed via property-value +## The behavior of @code{strread} can be changed via property-value ## pairs. The following properties are recognized: ## ## @table @code
--- a/scripts/miscellaneous/mkoctfile.m +++ b/scripts/miscellaneous/mkoctfile.m @@ -48,7 +48,7 @@ ## Generate dependency files (.d) for C and C++ source files. ## ## @item -R DIR -## Add the runtime path to the link command. +## Add the run-time path to the link command. ## ## @item -Wl,@dots{} ## Pass flags though the linker like "-Wl,-rpath=@dots{}".
--- a/scripts/plot/bar.m +++ b/scripts/plot/bar.m @@ -54,7 +54,7 @@ ## ## The optional input handle @var{h} allows an axis handle to be passed. ## -## The bargraph's appearance may be modified by specifying property/value +## The bar graph's appearance may be modified by specifying property/value ## pairs. The following example modifies the face and edge colors. ## ## @example
--- a/scripts/plot/errorbar.m +++ b/scripts/plot/errorbar.m @@ -52,7 +52,7 @@ ## ## If the @var{fmt} argument is supplied, it is interpreted as in ## normal plots. In addition, @var{fmt} may include an errorbar style -## which must preceed the line and marker format. The following plot +## which must precede the line and marker format. The following plot ## styles are supported by errorbar: ## ## @table @samp
--- a/scripts/plot/hist.m +++ b/scripts/plot/hist.m @@ -35,9 +35,9 @@ ## the bins, with the width of the bins determined from the adjacent ## values in the vector. ## -## If scaler, the second argument, @var{nbins}, defines the number of bins. +## If scalar, the second argument, @var{nbins}, defines the number of bins. ## -## If third argument is provided, the histogram is normalized such that +## If a third argument is provided, the histogram is normalized such that ## the sum of the bars is equal to @var{norm}. ## ## Extreme values are lumped in the first and last bins.
--- a/scripts/plot/mesh.m +++ b/scripts/plot/mesh.m @@ -29,7 +29,7 @@ ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. ## -## The color of the mesh is derirved from the @code{colormap} +## The color of the mesh is derived from the @code{colormap} ## and the value of @var{z}. Optionally the color of the mesh can be ## specified independent of @var{z}, by adding a fourth matrix, @var{c}. ## @seealso{colormap, contour, meshgrid, surf}
--- a/scripts/plot/surf.m +++ b/scripts/plot/surf.m @@ -29,7 +29,7 @@ ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. ## -## The color of the surface is derirved from the @code{colormap} and +## The color of the surface is derived from the @code{colormap} and ## the value of @var{z}. Optionally the color of the surface can be ## specified independent of @var{z}, by adding a fourth matrix, @var{c}. ## @seealso{colormap, contour, meshgrid, mesh}
--- a/scripts/polynomial/polyaffine.m +++ b/scripts/polynomial/polyaffine.m @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu}) ## Return the coefficients of the polynomial vector @var{f} after an affine -## tranformation. If @var{f} is the vector representing the polynomial f(x), +## transformation. If @var{f} is the vector representing the polynomial f(x), ## then @code{@var{g} = polyaffine (@var{f}, @var{mu})} is the vector ## representing: ##
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2011-01-19 Rik <octave@nomad.inbox5.com> + + * src/data.cc, src/input.cc, src/utils.cc: spellcheck docstrings. + 2011-01-19 Rik <octave@nomad.inbox5.com> * DLD-FUNCTIONS/dlmread.cc, DLD-FUNCTIONS/filter.cc,
--- a/src/data.cc +++ b/src/data.cc @@ -5023,7 +5023,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} mtimes (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} mtimes (@var{x1}, @var{x2}, @dots{})\n\ -Return the matrix multiplicaton product of inputs.\n\ +Return the matrix multiplication product of inputs.\n\ This function is equivalent to @w{@code{x * y}}.\n\ If more arguments are given, the multiplication is applied\n\ cumulatively from left to right:\n\ @@ -5032,7 +5032,7 @@ (@dots{}((x1 * x2) * x3) * @dots{})\n\ @end example\n\ \n\ -At least one argument is requred.\n\ +At least one argument is required.\n\ @seealso{times}\n\ @end deftypefn") {
--- a/src/input.cc +++ b/src/input.cc @@ -1379,14 +1379,14 @@ character string. @xref{Strings}.\n\ \n\ You can also use ANSI escape sequences if your terminal supports them.\n\ -This can be useful for colouring the prompt. For example,\n\ +This can be useful for coloring the prompt. For example,\n\ \n\ @example\n\ PS1 (\"\\\\[\\\\033[01;31m\\\\]\\\\s:\\\\#> \\\\[\\\\033[0m\\]\")\n\ @end example\n\ \n\ @noindent\n\ -will give the default Octave prompt a red colouring.\n\ +will give the default Octave prompt a red coloring.\n\ @seealso{PS2, PS4}\n\ @end deftypefn") {
--- a/src/utils.cc +++ b/src/utils.cc @@ -1301,7 +1301,7 @@ @deftypefn {Built-in Function} {} isindex (@var{ind})\n\ @deftypefnx {Built-in Function} {} isindex (@var{ind}, @var{n})\n\ Return true if @var{ind} is a valid index. Valid indices are\n\ -either positive integers (although possibly of real datatype), or logical\n\ +either positive integers (although possibly of real data type), or logical\n\ arrays. If present, @var{n} specifies the maximum extent of the dimension\n\ to be indexed. When possible the internal result is cached so that\n\ subsequent indexing using @var{ind} will not perform the check again.\n\