Mercurial > octave
changeset 26048:d02e4b1df697
doc: Spellcheck documentation.
* aspell-octave.en.pws: Add new words to Octave-specific dictionary.
* external.txi, preface.txi, open.m, fzero.m, print.m: Correct spellings
and add @nospell macro around words which shouldn't be checked.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 09 Nov 2018 22:02:30 -0800 |
| parents | 1357b79f87bc |
| children | 09665529b6ba |
| files | doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/external.txi doc/interpreter/preface.txi scripts/miscellaneous/open.m scripts/optimization/fzero.m scripts/plot/util/print.m |
| diffstat | 6 files changed, 92 insertions(+), 71 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Fri Nov 09 21:38:44 2018 -0800 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Fri Nov 09 22:02:30 2018 -0800 @@ -1,8 +1,8 @@ personal_ws-1.1 en 1 AbsTol accumarray +acknowledgements Acknowledgements -acknowledgements adams Affero afterwards @@ -51,8 +51,8 @@ Barycentric basevalue BaseValue +bdf BDF -bdf benchmarking betacdf betainc @@ -84,8 +84,8 @@ broadcastable BufSize builtin +bulleted Bulleted -bulleted ButtonDownFcn buttondownfcn BV @@ -143,11 +143,11 @@ colorcube colormap colormaps +ColorOrder colororder -ColorOrder colperm +CommentStyle commentstyle -CommentStyle ComplexEqn cond condest @@ -159,6 +159,7 @@ convhull Convolve copyrightable +CorelDraw corrcoef cosecant courseware @@ -174,8 +175,8 @@ CSV csymamd ctranspose +CTRL Ctrl -CTRL cubehelix cummax cummin @@ -207,10 +208,11 @@ deconv Deconvolve decrement +defaultaxesbox defaultuicontrolbackgroundcolor deftypefn +Delaunay delaunay -Delaunay delaunayn DeleteFcn deletefcn @@ -221,8 +223,8 @@ dggsvd diag diagcomp +Dialogs dialogs -Dialogs diamondsuit differentiable digamma @@ -230,8 +232,8 @@ dimensionally dir disp +displayname DisplayName -displayname displayrange dMatrix dmperm @@ -266,27 +268,27 @@ emptyvalue EmptyValue endfunction +endian Endian -endian endif +EndOfLine endofline -EndOfLine EOF EOLs eps eq equidistributed +equilibration Equilibration -equilibration equispaced erf erfc erfi errno +errorbar Errorbar -errorbar +errorbars Errorbars -errorbars errordlg ErrorHandler ESC @@ -307,8 +309,9 @@ facecolor FaceColor FaceLighting +FaceNormals +FaceVertexCData facevertexcdata -FaceVertexCData factorizations fcdf femmodel @@ -323,6 +326,7 @@ fieldnames FIFOs filename +FileName filenames filepaths Filesystem @@ -333,8 +337,9 @@ fitboxtotext FIXME flac +FLTK fltk -FLTK +fminsearch fminunc fontconfig fontname @@ -347,8 +352,8 @@ FreeBSD FreeSans freespacing +FreeType freetype -FreeType frnd Fs FSF @@ -387,10 +392,10 @@ GLS glyphs GMRES +gnuplot Gnuplot -gnuplot +Goto goto -Goto gouraud gperf GPL @@ -408,23 +413,24 @@ gzip gzipped Hadamard +handlevisibility HandleVisibility -handlevisibility Hankel Hanning hanning hardcode hardcoded hardcoding +hdf HDF -hdf +HeaderLines headerlines -HeaderLines headlength headstyle headwidth heartsuit helpdlg +Helvetica Hermitian Hessenberg heteroscedascity @@ -432,6 +438,7 @@ hggroup hggroups hgid +hgload HH hh histc @@ -451,8 +458,8 @@ ict IDE IEC +IEEE ieee -IEEE ifelse ifft ifftn @@ -521,11 +528,11 @@ JConstant JDK JIS +jit JIT -jit JPattern +jpeg JPEG -jpeg jpg jvm JVM's @@ -627,6 +634,7 @@ metadata metafile Metafile +MetaFile metafiles Metafont mex @@ -649,6 +657,7 @@ mmmm mmmyy mmmyyyy +movegui mpoles mpower mput @@ -661,8 +670,8 @@ Multi multibyte multipage +MultipleDelimsAsOne multipledelimsasone -MultipleDelimsAsOne MultiSelect multistep MvPattern @@ -670,10 +679,10 @@ myclass myfun nabla +NAMESPACE namespace -NAMESPACE +nan NaN -nan nanflag NaNs nargin @@ -707,6 +716,7 @@ nonnan NonNegative nonnegativity +nonskew nonsmooth nonsparse nonzeros @@ -734,8 +744,10 @@ octaverc ODEPACK ODEs +offscreen +ofig +Ogg ogg -Ogg OKString OLS omitnan @@ -743,6 +755,7 @@ online OpenBLAS OpenGL +opengl OpenJDK oplus optimizations @@ -769,8 +782,8 @@ PaperUnits parametrically parseparams +pbm PBM -pbm PBMplus pc pcg @@ -780,8 +793,8 @@ PCRE pcre PCX +pdf PDF -pdf pdflatex pentadiagonal periodogram @@ -794,8 +807,8 @@ Piecewise pinv PixelRegion +PNG png -PNG poisscdf poissinv poisspdf @@ -826,8 +839,8 @@ presolver printf priori +profiler Profiler -profiler programmatically prolate PromptString @@ -845,24 +858,24 @@ Qhull QP QQ +QRUPDATE qrupdate -QRUPDATE QScintilla quadcc quadgk quadl quadpack quadv +Quantile quantile -Quantile quantiles quantization quartic quartile questdlg Quickhull +qz QZ -qz radian radians radices @@ -878,8 +891,8 @@ ranlib rceil rdivide +Readline readline -Readline RECT recursing redistributable @@ -890,6 +903,7 @@ relicensing RelTol renderer +renderers repelems replacechildren repmat @@ -897,8 +911,8 @@ reproducibility resampled resampling +resize Resize -resize resized Resizing resizing @@ -909,13 +923,14 @@ restorePrevious RET retarget +returnonerror ReturnOnError -returnonerror rfloor +rgb RGB -rgb +RGBImage +rightarrow Rightarrow -rightarrow rle rline rmdir @@ -983,8 +998,8 @@ ss sT stairstep +Startup startup -Startup statinfo stdin stdout @@ -1000,8 +1015,9 @@ struct structs subarrays +subclasses Subclasses -subclasses +subdiagonal subdiagonals subdirectories subdirectory @@ -1011,8 +1027,8 @@ Subfunctions subfunctions subinterval +subintervals Subintervals -subintervals sublicenses Sublicensing submatrices @@ -1020,16 +1036,16 @@ submenu suboptimal subprocess +subprocesses Subprocesses -subprocesses subsasgn +subscripted Subscripted -subscripted subscripting subseteq subsindex +subspaces Subspaces -subspaces subsref substring substrings @@ -1047,15 +1063,15 @@ supseteq surd SV +svd SVD -svd svds -svg SVG -Sym +svg sym +Sym +SYMAMD symamd -SYMAMD symbfact symrcm Syntaxes @@ -1092,8 +1108,8 @@ TolF TolFun TolX +Toolkits toolkits -Toolkits toplevel TP tpdf @@ -1111,8 +1127,8 @@ trisurf trivariate trnd +TrueColor truecolor -TrueColor tuples txi typedefs @@ -1122,13 +1138,13 @@ uchar UHESS UI +Uibuttongroup uibuttongroup -Uibuttongroup uibuttongroups uicontextmenu Uicontextmenu +Uicontrol uicontrol -Uicontrol uicontrols UID uimenu @@ -1148,8 +1164,8 @@ Ultrix umfpack uminus +unary Unary -unary unconvertible undirected unifcdf @@ -1212,29 +1228,29 @@ waitbar waitbars warndlg +WAV wav -WAV -waypoints Waypoints WayPoints +waypoints wblcdf wblinv wblpdf wblrnd WestOutside +whitespace Whitespace -whitespace whos wienrnd Wikipedia wildcard +Wildcards wildcards -Wildcards windowbuttondownfcn windowbuttonmotionfcn windowbuttonupfcn +windowstyle WindowStyle -windowstyle WIPO wireframe workspace @@ -1247,10 +1263,12 @@ xerrorbar xerrorbars XFig +xfirst xGBTRF xGELSD xGETRF xGTSV +xlast xlim xlimmode xmax @@ -1278,17 +1296,19 @@ ydata yerrorbar yerrorbars +yfirst ylabel +ylast ylim ymax ymin ypos yticklabels yticks +YY yy -YY +yyyy YYYY -yyyy yyyymmddTHHMMSS zggsvd Ziggurat
--- a/doc/interpreter/external.txi Fri Nov 09 21:38:44 2018 -0800 +++ b/doc/interpreter/external.txi Fri Nov 09 22:02:30 2018 -0800 @@ -2092,7 +2092,7 @@ @node Set up the JVM @subsection Set up the JVM @cindex memory, limitations on JVM -@cindex select JVM vesion +@cindex select JVM version In order to execute Java code Octave creates a Java Virtual Machine (JVM). By default the version of the JVM is used that was detected during configuration @@ -2103,7 +2103,7 @@ environment variable @w{@env{JAVA_HOME}} to the path where the JVM is installed. On Windows that might be, for example, @file{C:\Program Files\Java\jre-10.0.2}. Make sure that you select a directory -that contains the JVM with a bit-ness that matches Octave's. +that contains the JVM with a @nospell{bit-ness} that matches Octave's. The JVM is only loaded once per Octave session. Thus, to change the used version of the JVM, you might have to re-start Octave. To check which version
--- a/doc/interpreter/preface.txi Fri Nov 09 21:38:44 2018 -0800 +++ b/doc/interpreter/preface.txi Fri Nov 09 22:02:30 2018 -0800 @@ -99,7 +99,7 @@ @item The industrial members of the Texas-Wisconsin Modeling and Control -Consortium (TWMCC). +Consortium (@nospell{TWMCC}). @item The @nospell{Paul A. Elfers} Endowed Chair in Chemical Engineering at the
--- a/scripts/miscellaneous/open.m Fri Nov 09 21:38:44 2018 -0800 +++ b/scripts/miscellaneous/open.m Fri Nov 09 22:02:30 2018 -0800 @@ -49,9 +49,9 @@ ## Custom file extensions may also be handled if a function @code{openxxx}, ## where @code{xxx} is the extension, is found in the load path. The function ## must accept the file name as input. For example, in order to load -## @qcode{".dat"} data files in the base workspace, as is done by default -## for @qcode{".mat"} files, one may define @qcode{"opendat.m"} with the -## following contents: +## @nospell{@qcode{".dat"}} data files in the base workspace, as is done by +## default for @qcode{".mat"} files, one may define +## @nospell{@qcode{"opendat.m"}} with the following contents: ## ## @example ## @group
--- a/scripts/optimization/fzero.m Fri Nov 09 21:38:44 2018 -0800 +++ b/scripts/optimization/fzero.m Fri Nov 09 22:02:30 2018 -0800 @@ -87,7 +87,7 @@ ## @item iterations ## Number of iterations through loop. ## -## @item funcCount +## @item @nospell{funcCount} ## Number of function evaluations. ## ## @item algorithm
--- a/scripts/plot/util/print.m Fri Nov 09 21:38:44 2018 -0800 +++ b/scripts/plot/util/print.m Fri Nov 09 22:02:30 2018 -0800 @@ -308,7 +308,8 @@ ## @item tif ## @itemx tiff ## @itemx tiffn -## TIFF image with LZW compression (tif, tiff) or uncompressed (tiffn). +## TIFF image with LZW compression (@nospell{tif}, tiff) or uncompressed +## (@nospell{tiffn}). ## ## @item tikz ## @itemx tikzstandalone*