Mercurial > octave
changeset 31376:ad8a4102f910
doc: Spellcheck documentation for 8.1 release.
* aspell-octave.en.pws: Update private dictionary with new Octave-specific
words and remove words no longer required.
* install.txi, preface.txi, vectorize.txi, interpreter.cc, qr.cc, uimenu.m,
uiputfile.m: Correct spellings and/or use @nospell macro to remove words
from spellchecking.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 31 Oct 2022 10:01:50 -0700 |
| parents | 96f751f8392c |
| children | b0dc52c6a9ee |
| files | doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/install.txi doc/interpreter/preface.txi doc/interpreter/vectorize.txi libinterp/corefcn/interpreter.cc libinterp/corefcn/qr.cc scripts/gui/uimenu.m scripts/gui/uiputfile.m |
| diffstat | 8 files changed, 116 insertions(+), 100 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Sun Oct 30 21:58:36 2022 -0700 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Mon Oct 31 10:01:50 2022 -0700 @@ -32,8 +32,8 @@ Autoconf autocorrelated autocovariances +autoload Autoload -autoload autoloaded Autoloading Automake @@ -48,8 +48,8 @@ backtrace bartlett Barycentric +BaseValue basevalue -BaseValue BDF bdf benchmarking @@ -67,6 +67,7 @@ binoinv binopdf Biomathematics +bitwidth bitwise blas bmp @@ -82,10 +83,10 @@ broadcastable BufSize builtin +bulleted Bulleted -bulleted +buttondownfcn ButtonDownFcn -buttondownfcn BV ByRows BZ @@ -144,11 +145,11 @@ colorcube colormap colormaps +ColorOrder colororder -ColorOrder colperm +commentstyle CommentStyle -commentstyle ComplexEqn cond condest @@ -172,8 +173,8 @@ CreateFcn CRLF crossflow +Crout crout -Crout cryptographic CSparse CSV @@ -220,16 +221,16 @@ Delaunay delaunay delaunayn +deletefcn DeleteFcn -deletefcn delim deltaX det dggsvd diag diagcomp +dialogs Dialogs -dialogs diamondsuit differentiable digamma @@ -256,8 +257,8 @@ dt dx dy +eastoutside EastOutside -eastoutside Econometrics edgecolor EdgeLighting @@ -270,8 +271,8 @@ elementwise elseif emacs +emptyvalue EmptyValue -emptyvalue encodings endfunction endian @@ -284,15 +285,15 @@ eps eq equidistributed +Equilibration equilibration -Equilibration equispaced erf erfc erfi errno +errorbar Errorbar -errorbar Errorbars errorbars errordlg @@ -330,8 +331,8 @@ fieldname fieldnames FIFOs +FileName filename -FileName filenames filepaths Filesystem @@ -346,10 +347,10 @@ FLTK fminsearch fminunc +FontConfig fontconfig -FontConfig +fontname FontName -fontname forall forcecelloutput foregroundcolor @@ -386,16 +387,18 @@ geq gesdd gesvd +getaudiodata +getplayer gfortran Ghostscript Ghostscript's +GIF gif -GIF glibc globbing glpk +GLS gls -GLS glyphs GMRES Gnuplot @@ -420,18 +423,18 @@ gzip gzipped Hadamard +HandleVisibility handlevisibility -HandleVisibility Hankel +Hanning hanning -Hanning hardcode hardcoded hardcoding +hdf HDF -hdf +headerlines HeaderLines -headerlines headlength headstyle headwidth @@ -446,8 +449,8 @@ hggroups hgid hgload +HH hh -HH histc holomorphic horizontalalignment @@ -459,6 +462,7 @@ hygecdf hygeinv hygepdf +hyperthreading hypervolume ichol ict @@ -469,8 +473,8 @@ ifelse ifft ifftn +ignorecase IgnoreCase -ignorecase ij ilu ilutp @@ -522,7 +526,9 @@ isosurface isosurfaces isovalue +isplaying isreal +isrecording issparse isvector iter @@ -530,6 +536,7 @@ ith iy iz +jacobian Jacobian Jacobians javaaddpath @@ -540,10 +547,11 @@ JDK JIS JPattern +JPEG jpeg -JPEG jpg JSON +Jupyter jvm JVM's kendall @@ -551,7 +559,6 @@ keypress keypressfcn KeyType -Konrod kron Krylov kurtosis @@ -597,8 +604,8 @@ logncdf logninv lognpdf +lookup Lookup -lookup lookups lossless lsode @@ -612,6 +619,7 @@ lz lzma lzw +Magick makefile makefiles makehgtform @@ -632,8 +640,13 @@ MaxStep mdl meansq +Memoization +memoize +memoized +memoizing menubar menubars +menuselectedfcn MERCHANTABILITY Mersenne meshgrid @@ -641,13 +654,12 @@ meshstyle metadata MetaFile +Metafile metafile -Metafile metafiles mex mget michol -Microsystems MinGW minima Minimizers @@ -677,19 +689,18 @@ multi multibyte multipage +MultipleDelimsAsOne multipledelimsasone -MultipleDelimsAsOne MultiSelect multistep MvPattern mxArray myclass -myfun nabla NAMESPACE namespace +NaN nan -NaN nancond nanflag NaNs @@ -705,7 +716,6 @@ ndims ne neq -NeXT NextPlot nfft ni @@ -746,7 +756,6 @@ NTSC numbertitle numel -Numpy nzmax oct octaverc @@ -778,18 +787,18 @@ outlier outliers OutputAllIndices +outputfcn OutputFcn -outputfcn OutputSel overdetermined overridable paperorientation +paperposition PaperPosition -paperposition paperpositionmode papersize +paperunits PaperUnits -paperunits parametrically parseparams pbm @@ -802,8 +811,8 @@ pcre PCRE PCX +PDF pdf -PDF pdflatex pentadiagonal periodogram @@ -812,10 +821,11 @@ PGMRES PHP pict +Piecewise piecewise -Piecewise pinv PixelRegion +playblocking PlotBoxAspectRatio png PNG @@ -840,8 +850,8 @@ precisiondate preconditioner preconditioners +preformatted Preformatted -preformatted premultiplied Prepend prepended @@ -851,8 +861,8 @@ PrettyWriter printf priori +Profiler profiler -Profiler programmatically prolate PromptString @@ -902,11 +912,13 @@ randperm rangle ranlib +RapidJSON rasterized rceil rdivide readline Readline +recordblocking RECT recursing redistributable @@ -938,14 +950,14 @@ restorePrevious RET retarget +returnonerror ReturnOnError -returnonerror rfloor RGB rgb RGBImage +Rightarrow rightarrow -Rightarrow rle rline rmdir @@ -961,7 +973,6 @@ Scalable schar Schur -SCO screenful sed seealso @@ -969,8 +980,8 @@ Sep SHA shiftdim +SIGNUM signum -SIGNUM sim SIMAX SIMD @@ -985,8 +996,8 @@ slcidx slx southeastoutside +SouthOutside southoutside -SouthOutside southwestoutside sp spadesuit @@ -1043,17 +1054,17 @@ struct structs subarrays +Subclasses subclasses -Subclasses subdiagonal subdiagonals subdirectories subdirectory subexpressions +subfunction Subfunction -subfunction +subfunctions Subfunctions -subfunctions subinterval Subintervals subintervals @@ -1067,8 +1078,8 @@ subprocesses Subprocesses subsasgn +Subscripted subscripted -Subscripted subscripting subseteq subsindex @@ -1091,15 +1102,15 @@ supseteq surd SV +svd SVD -svd svds SVG svg Sym sym +symamd SYMAMD -symamd symbfact symrcm Syntaxes @@ -1107,8 +1118,8 @@ terminal's tex texi +Texinfo texinfo -Texinfo TextAlphaBits textarrow textbackgroundcolor @@ -1123,6 +1134,7 @@ textscan th thetaticks +tickaligned ticklabels TikZ Timestamp @@ -1154,8 +1166,8 @@ triplot trisurf trivariate +truecolor TrueColor -truecolor tuples txi typedefs @@ -1167,10 +1179,10 @@ UI uibuttongroup Uibuttongroup +uicontextmenu Uicontextmenu -uicontextmenu +uicontrol Uicontrol -uicontrol uicontrols UID uimenu @@ -1183,18 +1195,17 @@ uipushtools uiputfile uitab +Uitable uitable -Uitable Uitoggletool uitoggletool +uitoolbar Uitoolbar -uitoolbar ulong -Ultrix umfpack uminus +unary Unary -unary unconvertible undirected unifcdf @@ -1215,6 +1226,7 @@ unpermuted unpivoted unregister +unregistering unscaled unshare Unshared @@ -1249,29 +1261,30 @@ vertices viewable viridis +vorbis Vorbis -vorbis +Voronoi voronoi -Voronoi waitbar waitbars +wav WAV -wav +waypoint +waypoints Waypoints -waypoints WayPoints wblcdf wblinv wblpdf +westoutside WestOutside -westoutside Whitespace whitespace whos Wikipedia wildcard +wildcards Wildcards -wildcards windowbuttondownfcn windowbuttonmotionfcn windowbuttonupfcn @@ -1282,6 +1295,7 @@ wlen workspace wp +writeable xb xboxes xc @@ -1336,8 +1350,8 @@ yticks yy YY +yyyy YYYY -yyyy yyyymmddTHHMMSS zggsvd Ziggurat
--- a/doc/interpreter/install.txi Sun Oct 30 21:58:36 2022 -0700 +++ b/doc/interpreter/install.txi Mon Oct 31 10:01:50 2022 -0700 @@ -317,7 +317,7 @@ been OpenGL-based. @item RapidJSON -A fast JSON parser/generator for C++ with both SAX/DOM style API +A fast JSON parser/generator for C++ with both @nospell{SAX/DOM} style API (@url{https://rapidjson.org/}). RapidJSON is required to read or write from or to JSON files with the functions @code{jsondecode} and @code{jsonencode}. @@ -649,7 +649,7 @@ @item SuiteSparse -@item @sc{sundials ida} +@item @sc{sundials @nospell{ida}} @item @sc{arpack} @end itemize @@ -795,7 +795,7 @@ @noindent Other systems may require a different solution. -@item @sc{sundials ida} +@item @sc{sundials @nospell{ida}} (@url{https://computing.llnl.gov/projects/sundials/ida}) When configuring with @code{cmake} add the flag @@ -884,7 +884,7 @@ @itemize @bullet @item -On some SCO systems, @code{info} fails to compile if +On some @nospell{SCO} systems, @code{info} fails to compile if @w{@code{HAVE_TERMIOS_H}} is defined in @file{config.h}. Simply removing the definition from @file{info/config.h} should allow it to compile. @@ -955,8 +955,8 @@ @noindent while compiling @file{sighandlers.cc}, you may need to edit some files in the @code{gcc} include subdirectory to add proper prototypes for -functions there. For example, Ultrix 4.2 needs proper declarations for -the @code{signal} function and the @w{@code{SIG_IGN}} macro in the file +functions there. For example, @nospell{Ultrix} 4.2 needs proper declarations +for the @code{signal} function and the @w{@code{SIG_IGN}} macro in the file @file{signal.h}. On some systems the @w{@code{SIG_IGN}} macro is defined to be something @@ -1022,7 +1022,7 @@ with optimization turned off. @item -On NeXT systems, if you get errors like this: +On @nospell{NeXT} systems, if you get errors like this: @example @group @@ -1065,7 +1065,7 @@ this issue. @item -On NeXT systems, linking to @file{libsys_s.a} may fail to resolve the +On @nospell{NeXT} systems, linking to @file{libsys_s.a} may fail to resolve the following functions @example
--- a/doc/interpreter/preface.txi Sun Oct 30 21:58:36 2022 -0700 +++ b/doc/interpreter/preface.txi Mon Oct 31 10:01:50 2022 -0700 @@ -110,7 +110,7 @@ External Research Program. @item -Sun Microsystems, Inc., for an Academic Equipment grant. +@nospell{Sun Microsystems}, Inc., for an Academic Equipment grant. @item International Business Machines, Inc., for providing equipment as part
--- a/doc/interpreter/vectorize.txi Sun Oct 30 21:58:36 2022 -0700 +++ b/doc/interpreter/vectorize.txi Mon Oct 31 10:01:50 2022 -0700 @@ -410,10 +410,10 @@ += -= .*= ./= .\= .^= &= |= @end example -Here is a real example of the power of broadcasting. The Floyd-Warshall -algorithm is used to calculate the shortest path lengths between every pair of -vertices in a graph. A naive implementation for a graph adjacency matrix of -order @var{n} might look like this: +Here is a real example of the power of broadcasting. The +@nospell{Floyd-Warshall} algorithm is used to calculate the shortest path +lengths between every pair of vertices in a graph. A naive implementation for +a graph adjacency matrix of order @var{n} might look like this: @example @group @@ -471,8 +471,8 @@ faster ordinary matrix multiplication, @code{@var{c} = @var{a}*@var{b};}. A note on terminology: ``broadcasting'' is the term popularized by the -Numpy numerical environment in the Python programming language. In other -programming languages and environments, broadcasting may also be known +@nospell{Numpy} numerical environment in the Python programming language. In +other programming languages and environments, broadcasting may also be known as @emph{binary singleton expansion} (@nospell{BSX}, in @sc{matlab}, and the origin of the name of the @code{bsxfun} function), @emph{recycling} (R programming language), @emph{single-instruction multiple data} (SIMD),
--- a/libinterp/corefcn/interpreter.cc Sun Oct 30 21:58:36 2022 -0700 +++ b/libinterp/corefcn/interpreter.cc Mon Oct 31 10:01:50 2022 -0700 @@ -270,10 +270,10 @@ @code{last_words} when it exits. The optional output @var{status} is only available when unregistering a -function. The value is true if the unregistering was succesful and false +function. The value is true if the unregistering was successful and false otherwise. -Progamming Note: @code{atexit} only removes the first occurrence of a function +Programming Note: @code{atexit} only removes the first occurrence of a function from the list; if a function was placed in the list multiple times with @code{atexit}, it must also be removed from the list multiple times. @seealso{quit}
--- a/libinterp/corefcn/qr.cc Sun Oct 30 21:58:36 2022 -0700 +++ b/libinterp/corefcn/qr.cc Mon Oct 31 10:01:50 2022 -0700 @@ -250,15 +250,15 @@ @end group @end example -If @var{A} is a sparse MxN matrix and an additional matrix @var{B} is +If @var{A} is a sparse @nospell{MxN} matrix and an additional matrix @var{B} is supplied, one or two return values are possible. If one return value @var{X} is requested and M < N, then @var{X} is the minimum 2-norm solution of @w{@code{@var{A} \ @var{B}}}. If M >= N, @var{X} is the least squares approximation @w{of @code{@var{A} \ @var{B}}}. If two return values are requested, @var{C} and @var{R} have the same meaning as in the dense case -(@var{C} is dense and @var{R} is sparse). -The version with one return parameter should be preferred because -it uses less memory and can handle rank-deficient matrices better. +(@var{C} is dense and @var{R} is sparse). The version with one return +parameter should be preferred because it uses less memory and can handle +rank-deficient matrices better. If the final argument is the string @qcode{"vector"} then @var{P} is a permutation vector (of the columns of @var{A}) instead of a permutation @@ -271,14 +271,14 @@ The default, however, is to return a permutation matrix and this may be explicitly specified by using a final argument of @qcode{"matrix"}. -If the final argument is the scalar 0 or the string @qcode{"econ"}, an -economy factorization is returned. If the original matrix @var{A} has size -MxN and M > N, then the economy factorization will calculate just N rows in -@var{R} and N columns in @var{Q} and omit the zeros in @var{R}. If M @leq{} -N, there is no difference between the economy and standard factorizations. -When calculating an economy factorization and @var{A} is dense, the output -@var{P} is always a vector rather than a matrix. If @var{A} is sparse, -output @var{P} is a sparse permutation matrix. +If the final argument is the scalar 0 or the string @qcode{"econ"}, an economy +factorization is returned. If the original matrix @var{A} has size +@nospell{MxN} and M > N, then the economy factorization will calculate just N +rows in @var{R} and N columns in @var{Q} and omit the zeros in @var{R}. If M +@leq{} N, there is no difference between the economy and standard +factorizations. When calculating an economy factorization and @var{A} is +dense, the output @var{P} is always a vector rather than a matrix. If @var{A} +is sparse, output @var{P} is a sparse permutation matrix. Background: The QR factorization has applications in the solution of least squares problems
--- a/scripts/gui/uimenu.m Sun Oct 30 21:58:36 2022 -0700 +++ b/scripts/gui/uimenu.m Mon Oct 31 10:01:50 2022 -0700 @@ -50,9 +50,10 @@ ## ## @item @qcode{"menuselectedfcn"} ## The function called when this menu entry is executed. It can be either a -## function string (e.g., @qcode{"myfcn"}), a function handle (e.g., @@myfcn) -## or a cell array containing the function handle and arguments for the -## callback function (e.g., @{@@myfcn, arg1, arg2@}). +## function string (e.g., @qcode{"@nospell{myfcn}"}), a function handle (e.g., +## @@@nospell{myfcn}) or a cell array containing the function handle and +## arguments for the callback function (e.g., @{@@@nospell{myfcn}, arg1, +## arg2@}). ## ## @item @qcode{"position"} ## A scalar value containing the relative menu position. The first position
--- a/scripts/gui/uiputfile.m Sun Oct 30 21:58:36 2022 -0700 +++ b/scripts/gui/uiputfile.m Mon Oct 31 10:01:50 2022 -0700 @@ -37,7 +37,8 @@ ## @item @qcode{"/path/to/filename.ext"} ## If a filename is given the file extension is extracted and used as filter. ## In addition the path is selected as current path in the dialog and the -## filename is selected as default file. Example: @code{uiputfile ("myfcn.m")} +## filename is selected as default file. Example: +## @code{uiputfile ("myfcn.m")} ## ## @item @qcode{"*.ext"} ## A single file extension.