Mercurial > octave
changeset 30371:1c114a55f4fb stable
doc: Spellcheck documentation ahead of 7.1 release.
* aspell-octave.en.pws: Add new words to private Octave dictionary.
* ordqz.cc (Fordqz), eigs.m, : Add @nospell macro acround terms which shouldn't
be spellchecked.
* iqr.m: Fix typo.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 26 Nov 2021 15:35:44 -0800 |
| parents | dbff48b54dd2 |
| children | e3b82be1d318 2f4cd1952f0b |
| files | doc/interpreter/diffeq.txi doc/interpreter/doccheck/aspell-octave.en.pws libinterp/corefcn/ordqz.cc scripts/sparse/eigs.m scripts/statistics/iqr.m |
| diffstat | 5 files changed, 82 insertions(+), 72 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/diffeq.txi Fri Nov 26 14:25:46 2021 -0800 +++ b/doc/interpreter/diffeq.txi Fri Nov 26 15:35:44 2021 -0800 @@ -155,7 +155,7 @@ See @nospell{K. E. Brenan}, et al., @cite{Numerical Solution of Initial-Value Problems in Differential-Algebraic Equations}, North-Holland (1989), -DOI: @url{https://doi.org/10.1137/1.9781611971224}, +@nospell{DOI}: @url{https://doi.org/10.1137/1.9781611971224}, for more information about the implementation of @sc{dassl}. @@ -212,7 +212,7 @@ Detailed information on the solvers are given in @nospell{L. F. Shampine} and @nospell{M. W. Reichelt}, @cite{The MATLAB ODE Suite}, SIAM Journal on Scientific Computing, Vol. 18, 1997, pp. 1–22, -DOI: @url{https://doi.org/10.1137/S1064827594276424}. +@nospell{DOI}: @url{https://doi.org/10.1137/S1064827594276424}. @DOCSTRING(ode45)
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Fri Nov 26 14:25:46 2021 -0800 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Fri Nov 26 15:35:44 2021 -0800 @@ -1,8 +1,8 @@ personal_ws-1.1 en 1 AbsTol accumarray +acknowledgements Acknowledgements -acknowledgements adams Affero afterwards @@ -32,8 +32,8 @@ Autoconf autocorrelated autocovariances +Autoload autoload -Autoload autoloaded Autoloading Automake @@ -87,6 +87,7 @@ ButtonDownFcn buttondownfcn BV +ByRows BZ bzip CallbackObject @@ -99,8 +100,8 @@ cd cdata cdatamapping +cdf CDF -cdf cdot ceil cellstr @@ -171,15 +172,15 @@ CreateFcn CRLF crossflow +crout Crout -crout cryptographic CSparse CSV csymamd ctranspose +Ctrl CTRL -Ctrl cubehelix cummax cummin @@ -199,6 +200,7 @@ dasrt dassl DataAspectRatio +DataScale dataset datasource datenum @@ -215,19 +217,19 @@ defaultaxesbox defaultuicontrolbackgroundcolor deftypefn +Delaunay delaunay -Delaunay delaunayn +DeleteFcn deletefcn -DeleteFcn delim deltaX det dggsvd diag diagcomp +Dialogs dialogs -Dialogs diamondsuit differentiable digamma @@ -272,18 +274,18 @@ emptyvalue encodings endfunction +endian Endian -endian endif +endofline EndOfLine -endofline EOF EOLs eps eq equidistributed +equilibration Equilibration -equilibration equispaced erf erfc @@ -309,8 +311,8 @@ exppdf extendedtext extrema +facecolor FaceColor -facecolor FaceLighting FaceNormals FaceVertexCData @@ -344,8 +346,8 @@ FLTK fminsearch fminunc +fontconfig FontConfig -fontconfig FontName fontname forall @@ -376,6 +378,7 @@ gcd ge GECOS +gejsv geocdf geoinv geopdf @@ -386,20 +389,20 @@ gfortran Ghostscript Ghostscript's +gif GIF -gif glibc globbing glpk +gls GLS -gls glyphs GMRES +Gnuplot gnuplot -Gnuplot GNUTERM +goto Goto -goto gouraud gperf GPL @@ -417,16 +420,16 @@ gzip gzipped Hadamard +handlevisibility HandleVisibility -handlevisibility Hankel +hanning Hanning -hanning hardcode hardcoded hardcoding +HDF hdf -HDF HeaderLines headerlines headlength @@ -450,8 +453,8 @@ horizontalalignment horzcat hostname +hsv HSV -hsv html hygecdf hygeinv @@ -461,13 +464,13 @@ ict IDE IEC +IEEE ieee -IEEE ifelse ifft ifftn +IgnoreCase ignorecase -IgnoreCase ij ilu ilutp @@ -554,7 +557,6 @@ kurtosis LabelSpacing langle -Lanzcos lapack LaserJet LaTeX @@ -564,8 +566,8 @@ ldots le leaveInPlace +leftarrow Leftarrow -leftarrow leftrightarrow leq lfloor @@ -595,8 +597,8 @@ logncdf logninv lognpdf +Lookup lookup -Lookup lookups lossless lsode @@ -614,6 +616,7 @@ makefiles makehgtform makeinfo +makeValidName Mandriva markeredgecolor markerfacecolor @@ -637,9 +640,9 @@ meshgridded meshstyle metadata +MetaFile metafile Metafile -MetaFile metafiles mex mget @@ -683,8 +686,8 @@ myclass myfun nabla +NAMESPACE namespace -NAMESPACE nan NaN nancond @@ -751,16 +754,16 @@ ODEs offscreen ofig +ogg Ogg -ogg OKString OLS omitnan onCleanup online OpenBLAS +opengl OpenGL -opengl OpenJDK oplus optimizations @@ -774,32 +777,33 @@ outerposition outlier outliers +OutputAllIndices +OutputFcn outputfcn -OutputFcn OutputSel overdetermined overridable paperorientation +PaperPosition paperposition -PaperPosition paperpositionmode papersize +PaperUnits paperunits -PaperUnits parametrically parseparams pbm PBMplus pc +pcg PCG -pcg pchip pcr pcre PCRE PCX +pdf PDF -pdf pdflatex pentadiagonal periodogram @@ -833,6 +837,7 @@ powerset pre preallocate +precisiondate preconditioner preconditioners Preformatted @@ -842,11 +847,12 @@ prepended preselected presolver +PrettyPrint PrettyWriter printf priori +profiler Profiler -profiler programmatically prolate PromptString @@ -861,8 +867,8 @@ pushbutton pushbuttons Pxx +qhull Qhull -qhull QP QQ qrupdate @@ -873,8 +879,8 @@ quadl quadpack quadv +quantile Quantile -quantile quantiles quantization quartic @@ -919,8 +925,8 @@ reproducibility resampled resampling +resize Resize -resize resized resizing Resizing @@ -935,8 +941,8 @@ ReturnOnError returnonerror rfloor +RGB rgb -RGB RGBImage rightarrow Rightarrow @@ -963,8 +969,8 @@ Sep SHA shiftdim +signum SIGNUM -signum sim SIMAX SIMD @@ -1000,6 +1006,7 @@ spmatrix spones spparms +SPQR sprand sprandn sprandsym @@ -1012,8 +1019,8 @@ ss sT stairstep +startup Startup -startup statinfo stdin stdout @@ -1025,8 +1032,8 @@ Streamribbons streamribbons streamtube +streamtubes Streamtubes -streamtubes stringanchors strncmp strncmpi @@ -1057,16 +1064,16 @@ submenu suboptimal subprocess +subprocesses Subprocesses -subprocesses subsasgn subscripted Subscripted subscripting subseteq subsindex +subspaces Subspaces -subspaces subsref substring substrings @@ -1084,15 +1091,15 @@ supseteq surd SV +SVD svd -SVD svds +SVG svg -SVG Sym sym +SYMAMD symamd -SYMAMD symbfact symrcm Syntaxes @@ -1100,8 +1107,8 @@ terminal's tex texi +texinfo Texinfo -texinfo TextAlphaBits textarrow textbackgroundcolor @@ -1129,16 +1136,16 @@ TolFun TolX toolchain +toolkits Toolkits -toolkits toplevel TP tpdf traceback TRANSA trapz +TreatAsEmpty treatasempty -TreatAsEmpty treelayout treeplot tridiagonal @@ -1162,8 +1169,8 @@ Uibuttongroup Uicontextmenu uicontextmenu +Uicontrol uicontrol -Uicontrol uicontrols UID uimenu @@ -1176,8 +1183,8 @@ uipushtools uiputfile uitab +uitable Uitable -uitable Uitoggletool uitoggletool Uitoolbar @@ -1242,29 +1249,29 @@ vertices viewable viridis +Vorbis vorbis -Vorbis voronoi Voronoi waitbar waitbars +WAV wav -WAV Waypoints waypoints WayPoints wblcdf wblinv wblpdf +WestOutside westoutside -WestOutside +Whitespace whitespace -Whitespace whos Wikipedia wildcard +Wildcards wildcards -Wildcards windowbuttondownfcn windowbuttonmotionfcn windowbuttonupfcn @@ -1303,6 +1310,7 @@ xtick xticklabel xticklabelmode +XTickLabelRotation xtickmode xticks xTRTRS @@ -1323,10 +1331,11 @@ ymax ymin ypos +ytickangle yticklabels yticks +yy YY -yy YYYY yyyy yyyymmddTHHMMSS @@ -1338,5 +1347,6 @@ zlim zmax zmin +ztickangle zticklabels zticks
--- a/libinterp/corefcn/ordqz.cc Fri Nov 26 14:25:46 2021 -0800 +++ b/libinterp/corefcn/ordqz.cc Fri Nov 26 15:35:44 2021 -0800 @@ -117,7 +117,7 @@ following way: @table @asis -@item @qcode{"S"}, @qcode{"udi"} +@item @qcode{"S"}, @nospell{@qcode{"udi"}} small: leading block has all @tex $|\lambda| < 1$ @@ -126,7 +126,7 @@ |@var{lambda}| < 1 @end ifnottex -@item @qcode{"B"}, @qcode{"udo"} +@item @qcode{"B"}, @nospell{@qcode{"udo"}} big: leading block has all @tex $|\lambda| \geq 1$ @@ -135,11 +135,11 @@ |@var{lambda}| @geq{} 1 @end ifnottex -@item @qcode{"-"}, @qcode{"lhp"} +@item @qcode{"-"}, @nospell{@qcode{"lhp"}} negative real part: leading block has all eigenvalues in the open left half-plane -@item @qcode{"+"}, @qcode{"rhp"} +@item @qcode{"+"}, @nospell{@qcode{"rhp"}} non-negative real part: leading block has all eigenvalues in the closed right half-plane @end table
--- a/scripts/sparse/eigs.m Fri Nov 26 14:25:46 2021 -0800 +++ b/scripts/sparse/eigs.m Fri Nov 26 15:35:44 2021 -0800 @@ -135,10 +135,10 @@ ## The maximum number of iterations. The default is 300. ## ## @item p -## The number of Lanzcos basis vectors to use. More vectors will result in -## faster convergence, but a greater use of memory. The optimal value of -## @code{p} is problem dependent and should be in the range @code{@var{k} + 1} -## to @var{n}. The default value is @code{2 * @var{k}}. +## The number of @nospell{Lanczos} basis vectors to use. More vectors will +## result in faster convergence, but a greater use of memory. The optimal +## value of @code{p} is problem dependent and should be in the range +## @code{@var{k} + 1} to @var{n}. The default value is @code{2 * @var{k}}. ## ## @item v0 ## The starting vector for the algorithm. An initial vector close to the final @@ -204,8 +204,8 @@ ## Programming Notes: For small problems, @var{n} < 500, consider using ## @code{eig (full (@var{A}))}. ## -## If @sc{arpack} fails to converge consider increasing the number of Lanczos -## vectors (@var{opt}.p), increasing the number of iterations +## If @sc{arpack} fails to converge consider increasing the number of +## @nospell{Lanczos} vectors (@var{opt}.p), increasing the number of iterations ## (@var{opt}.maxiter), or decreasing the tolerance (@var{opt}.tol). ## ## Reference:
--- a/scripts/statistics/iqr.m Fri Nov 26 14:25:46 2021 -0800 +++ b/scripts/statistics/iqr.m Fri Nov 26 15:35:44 2021 -0800 @@ -46,7 +46,7 @@ ## over the specified dimension. @var{dim} can either be a scalar dimension or ## a vector of non-repeating dimensions over which to operate. In either case ## @var{dim} must be positive integers. A vector @var{dim} concatenates all -## specified diminsions for independent operation by @code{iqr}. +## specified dimensions for independent operation by @code{iqr}. ## ## Specifying dimension @qcode{"ALL"} will force @code{iqr} to operate ## on all elements of @var{x}, and is equivalent to @code{iqr (@var{x}(:))}.