Mercurial > octave
changeset 28962:90c39bbbe5cd
doc: Review doccheck files for checking documentation.
* doc/interpreter/doccheck/README: Fix typo.
* aspell-octave.en.pws: Remove words from private dictionary that are no longer
in documentation.
* mk_undocumented_list: Don't require DOCSTRING entry for files in legacy/ dir.
Use foreach rather than map construct since output of map is never used.
Add gui_mainfcn to list of functions not requiring a documentation entry.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Oct 2020 20:16:21 -0700 |
| parents | d9d028b479ac |
| children | f29e4791a792 |
| files | doc/interpreter/doccheck/README doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/doccheck/mk_undocumented_list |
| diffstat | 3 files changed, 65 insertions(+), 94 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/README Mon Oct 19 09:49:03 2020 -0700 +++ b/doc/interpreter/doccheck/README Mon Oct 19 20:16:21 2020 -0700 @@ -78,7 +78,7 @@ which can be added to the private dictionary. Instead the source is marked up: Manchester @nospell{Centre} for Computational Mathematics. -aspell will no longer reports any misspellings for linalg.texi. +aspell will no longer report any misspellings for linalg.texi. GRAMMAR:
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Mon Oct 19 09:49:03 2020 -0700 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Mon Oct 19 20:16:21 2020 -0700 @@ -22,8 +22,6 @@ arpack ArrayValued ascii -associativity -Associativity ast async atan @@ -31,12 +29,11 @@ audiodevinfo audioplayer audiorecorder -AutoCAD Autoconf autocorrelated autocovariances +autoload Autoload -autoload autoloaded Autoloading Automake @@ -51,8 +48,8 @@ backtrace bartlett Barycentric +basevalue BaseValue -basevalue BDF bdf benchmarking @@ -61,7 +58,6 @@ betainv betaln betapdf -betarnd BFGS BICG BiConjugate @@ -70,9 +66,7 @@ binocdf binoinv binopdf -binornd Biomathematics -bitmapped bitwise blas bmp @@ -88,10 +82,10 @@ broadcastable BufSize builtin +Bulleted bulleted -Bulleted +ButtonDownFcn buttondownfcn -ButtonDownFcn BV BZ bzip @@ -105,8 +99,8 @@ cd cdata cdatamapping +CDF cdf -CDF cdot ceil cellstr @@ -149,8 +143,8 @@ colorcube colormap colormaps +colororder ColorOrder -colororder colperm CommentStyle commentstyle @@ -166,7 +160,6 @@ convhull Convolve copyrightable -CorelDraw corrcoef cosecant courseware @@ -178,8 +171,8 @@ CreateFcn CRLF crossflow +Crout crout -Crout cryptographic CSparse CSV @@ -207,7 +200,6 @@ dassl DataAspectRatio dataset -datasets datasource datenum datenums @@ -230,13 +222,12 @@ DeleteFcn delim deltaX -demi det dggsvd diag diagcomp +dialogs Dialogs -dialogs diamondsuit differentiable digamma @@ -244,8 +235,8 @@ dimensionally dir disp +displayname DisplayName -displayname displayrange dMatrix dmperm @@ -259,13 +250,12 @@ doublearrow downarrow downdate -dpi droptol dt dx dy +EastOutside eastoutside -EastOutside Econometrics edgecolor EdgeLighting @@ -301,8 +291,8 @@ errno Errorbar errorbar +Errorbars errorbars -Errorbars errordlg ErrorHandler ESC @@ -317,15 +307,14 @@ expcdf expinv exppdf -exprnd extendedtext extrema +FaceColor facecolor -FaceColor FaceLighting FaceNormals +FaceVertexCData facevertexcdata -FaceVertexCData factorizations fcdf femmodel @@ -355,10 +344,10 @@ FLTK fminsearch fminunc +FontConfig fontconfig -FontConfig +FontName fontname -FontName forall forcecelloutput foregroundcolor @@ -369,9 +358,8 @@ FreeBSD FreeSans freespacing +freetype FreeType -freetype -frnd Fs FSF fullpath @@ -381,7 +369,6 @@ gamcdf gaminv gampdf -gamrnd gaussian gca gcbo @@ -389,11 +376,9 @@ gcd ge GECOS -genvarname geocdf geoinv geopdf -geornd geotagging geq gesdd @@ -401,8 +386,8 @@ gfortran Ghostscript Ghostscript's +GIF gif -GIF glibc globbing glpk @@ -410,8 +395,8 @@ gls glyphs GMRES +gnuplot Gnuplot -gnuplot GNUTERM Goto goto @@ -432,8 +417,8 @@ gzip gzipped Hadamard +HandleVisibility handlevisibility -HandleVisibility Hankel Hanning hanning @@ -458,8 +443,8 @@ hggroups hgid hgload +hh HH -hh histc holomorphic horizontalalignment @@ -471,14 +456,13 @@ hygecdf hygeinv hygepdf -hygernd hypervolume ichol ict IDE IEC +ieee IEEE -ieee ifelse ifft ifftn @@ -491,15 +475,14 @@ imag ImageMagick includenan +indices Indices -indices infeasible infty init InitialSlope InitialStep InitialValue -Inline inline inmax inmin @@ -553,8 +536,8 @@ JConstant JDK JIS +jit JIT -jit JPattern jpeg JPEG @@ -583,8 +566,8 @@ ldots le leaveInPlace +Leftarrow leftarrow -Leftarrow leftrightarrow leq lfloor @@ -615,7 +598,6 @@ logncdf logninv lognpdf -lognrnd lookup Lookup lookups @@ -658,11 +640,10 @@ meshgridded meshstyle metadata -MetaFile +metafile Metafile -metafile +MetaFile metafiles -Metafont mex mget michol @@ -692,12 +673,12 @@ MStateDependence MSYS mtimes +Multi multi -Multi multibyte multipage +multipledelimsasone MultipleDelimsAsOne -multipledelimsasone MultiSelect multistep MvPattern @@ -705,10 +686,10 @@ myclass myfun nabla +namespace NAMESPACE -namespace +nan NaN -nan nancond nanflag NaNs @@ -718,7 +699,6 @@ nbincdf nbininv nbinpdf -nbinrnd ncols nd ndgrid @@ -727,7 +707,6 @@ neq NeXT NextPlot -nfev nfft ni NLP @@ -740,7 +719,6 @@ nonconformant nondecreasing nonincreasing -nonmodal nonnan NonNegative nonnegativity @@ -757,10 +735,9 @@ normest norminv normpdf -normrnd northeastoutside +northoutside NorthOutside -northoutside northwestoutside noscal noshare @@ -777,16 +754,16 @@ ODEs offscreen ofig +Ogg ogg -Ogg OKString OLS omitnan onCleanup online OpenBLAS +OpenGL opengl -OpenGL OpenJDK oplus optimizations @@ -806,20 +783,19 @@ overdetermined overridable paperorientation +paperposition PaperPosition -paperposition paperpositionmode papersize +paperunits PaperUnits -paperunits parametrically parseparams -PBM pbm PBMplus pc +PCG pcg -PCG pchip pcr pcre @@ -840,12 +816,11 @@ pinv PixelRegion PlotBoxAspectRatio +png PNG -png poisscdf poissinv poisspdf -poissrnd polyderiv polyeig polyfit @@ -863,8 +838,8 @@ preallocate preconditioner preconditioners +Preformatted preformatted -Preformatted premultiplied Prepend prepended @@ -889,28 +864,28 @@ pushbutton pushbuttons Pxx +Qhull qhull -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 @@ -939,7 +914,6 @@ relicensing RelTol renderer -renderers repelems replacechildren ReplacementStyle @@ -951,8 +925,8 @@ Resize resize resized +resizing Resizing -resizing resnorm resparsify restacks @@ -961,8 +935,8 @@ restorePrevious RET retarget +ReturnOnError returnonerror -ReturnOnError rfloor rgb RGB @@ -1008,8 +982,8 @@ slcidx slx southeastoutside +southoutside SouthOutside -southoutside southwestoutside sp spadesuit @@ -1065,15 +1039,15 @@ struct structs subarrays +subclasses Subclasses -subclasses subdiagonal subdiagonals subdirectories subdirectory subexpressions +Subfunction subfunction -Subfunction Subfunctions subfunctions subinterval @@ -1113,15 +1087,15 @@ supseteq surd SV +svd SVD -svd svds svg SVG Sym sym +symamd SYMAMD -symamd symbfact symrcm Syntaxes @@ -1129,8 +1103,8 @@ terminal's tex texi +Texinfo texinfo -Texinfo TextAlphaBits textarrow textbackgroundcolor @@ -1155,12 +1129,11 @@ togglebutton togglebuttons tokenExtents -TolF TolFun TolX toolchain +Toolkits toolkits -Toolkits toplevel TP tpdf @@ -1177,7 +1150,6 @@ triplot trisurf trivariate -trnd TrueColor truecolor tuples @@ -1191,9 +1163,8 @@ UI uibuttongroup Uibuttongroup -uibuttongroups +Uicontextmenu uicontextmenu -Uicontextmenu uicontrol Uicontrol uicontrols @@ -1208,10 +1179,10 @@ uipushtools uiputfile uitab +Uitable uitable -Uitable +Uitoggletool uitoggletool -Uitoggletool Uitoolbar uitoolbar ulong @@ -1227,7 +1198,6 @@ UniformOutput UniformValues unifpdf -unifrnd unimodal Uninstall uninstalled @@ -1281,31 +1251,28 @@ Voronoi waitbar waitbars -warndlg wav WAV +Waypoints waypoints WayPoints -Waypoints wblcdf wblinv wblpdf -wblrnd +westoutside WestOutside -westoutside whitespace Whitespace whos -wienrnd Wikipedia wildcard +wildcards Wildcards -wildcards windowbuttondownfcn windowbuttonmotionfcn windowbuttonupfcn +WindowStyle windowstyle -WindowStyle WIPO wireframe wlen
--- a/doc/interpreter/doccheck/mk_undocumented_list Mon Oct 19 09:49:03 2020 -0700 +++ b/doc/interpreter/doccheck/mk_undocumented_list Mon Oct 19 20:16:21 2020 -0700 @@ -64,10 +64,12 @@ } # Second, remove functions based on directory location -# deprecated directory, doc/interpreter directory, test/ directory +# deprecated directory, legacy directory, doc/interpreter directory, +# test/ directory FUNC: foreach $idx (0 .. $#where) { next FUNC if ($where[$idx] =~ /deprecated/i); + next FUNC if ($where[$idx] =~ /legacy/i); next FUNC if ($where[$idx] =~ /interpreter/i); next FUNC if ($where[$idx] =~ m#test/#i); @@ -81,7 +83,8 @@ # Fourth, remove exceptions based on name that do not require documentation # Load list of function exceptions not requiring a DOCSTRING # Exception data is stored at the bottom of this script -map { chomp, $exceptions{$_}=1; } <DATA>; +foreach $_ (<DATA>) +{ chomp, $exceptions{$_}=1; } # Remove exception data from the list @functions = grep (! $exceptions{$_}, @functions); @@ -135,6 +138,7 @@ flipdim fmod gammaln +gui_mainfcn home i ifelse