changeset 23567:71bfd507663c

doc: Periodic spellcheck of documentation. * aspell-octave.en.pws: Add new words to Octave-specific dictionary. * external.txi, install.txi, svd.cc, audiodevinfo.cc, uipushtool.m, getframe.m, fminsearch.m, axis.m: Correct spelling or add @nospell macro around words.
author Rik <rik@octave.org>
date Thu, 08 Jun 2017 18:24:28 -0700
parents 91d260dd2df3
children 21b906769c0d
files doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/external.txi doc/interpreter/install.txi libinterp/corefcn/svd.cc libinterp/dldfcn/audiodevinfo.cc scripts/gui/uipushtool.m scripts/image/getframe.m scripts/optimization/fminsearch.m scripts/plot/appearance/axis.m
diffstat 9 files changed, 111 insertions(+), 67 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws	Thu Jun 08 17:46:51 2017 -0700
+++ b/doc/interpreter/doccheck/aspell-octave.en.pws	Thu Jun 08 18:24:28 2017 -0700
@@ -1,7 +1,8 @@
 personal_ws-1.1 en 1
+AbsTol
 accumarray
+Acknowledgements
 acknowledgements
-Acknowledgements
 ACM
 adams
 Affero
@@ -43,8 +44,8 @@
 autoload
 Autoload
 autoloaded
+autoloading
 Autoloading
-autoloading
 Automake
 autoregression
 autoregressions
@@ -103,10 +104,10 @@
 BufSize
 builtin
 builtins
+Bulleted
 bulleted
-Bulleted
+buttondownfcn
 ButtonDownFcn
-buttondownfcn
 BV
 BZ
 bz
@@ -120,6 +121,7 @@
 ccolamd
 cd
 cdata
+cdatamapping
 cdf
 CDF
 CDFs
@@ -147,6 +149,7 @@
 circshift
 circulant
 circum
+classdef
 classpath
 classpaths
 CLI
@@ -161,12 +164,14 @@
 CMYK
 cntrl
 codebases
+codepage
 cof
 coffset
 colamd
 collectoutput
 CollectOutput
 colorbar
+colorcube
 colormap
 colormaps
 colororder
@@ -174,8 +179,8 @@
 colperm
 Comint
 Commandline
+CommentStyle
 commentstyle
-CommentStyle
 compilable
 ComplexEqn
 cond
@@ -199,14 +204,14 @@
 createcancelbtn
 CreateFcn
 CRLF
+Crout
 crout
-Crout
 cryptographic
 CSV
 csymamd
 ctranspose
+Ctrl
 CTRL
-Ctrl
 CTS
 cubehelix
 cummax
@@ -238,6 +243,7 @@
 dddd
 deallocate
 deallocated
+deallocating
 deconv
 Deconvolve
 decrement
@@ -265,8 +271,8 @@
 dimensionally
 dir
 disp
+DisplayName
 displayname
-DisplayName
 DisplayNames
 displayrange
 distributable
@@ -306,8 +312,8 @@
 EmptyValue
 emptyvalue
 endfunction
+Endian
 endian
-Endian
 endif
 EndOfLine
 endofline
@@ -325,8 +331,8 @@
 erfc
 erfi
 errno
+Errorbar
 errorbar
-Errorbar
 errorbars
 Errorbars
 errordlg
@@ -336,6 +342,7 @@
 etree
 etreeplot
 eval
+evalc
 Executables
 Exif
 exitflag
@@ -344,9 +351,11 @@
 exppdf
 exprnd
 extendedtext
+FaceColor
 facecolor
 FaceLighting
 facevertexcdata
+FaceVertexCData
 factorizations
 fcdf
 femmodel
@@ -430,8 +439,8 @@
 Gnuplot
 gnuplot
 gnuplot's
+Goto
 goto
-Goto
 gotos
 gouraud
 gperf
@@ -452,18 +461,18 @@
 gzip
 gzipped
 Hadamard
+handlevisibility
 HandleVisibility
-handlevisibility
 Hankel
 hanning
 Hanning
 hardcode
 hardcoded
 hardcoding
+HDF
 hdf
-HDF
+HeaderLines
 headerlines
-HeaderLines
 headlength
 headstyle
 headwidth
@@ -475,8 +484,8 @@
 heteroscedascity
 hggroup
 hggroups
+HH
 hh
-HH
 histc
 holomorphic
 horizontalalignment
@@ -485,6 +494,7 @@
 hostname
 hotelling
 Hotelling's
+hsv
 HSV
 html
 hygecdf
@@ -496,6 +506,7 @@
 hypervolume
 ichol
 ict
+IDE
 IEC
 ieee
 IEEE
@@ -514,9 +525,11 @@
 infeasible
 infty
 init
+InitialSlope
+InitialStep
 InitialValue
+inline
 Inline
-inline
 inpolygon
 inputdlg
 integerhandle
@@ -537,6 +550,7 @@
 inverthardcopy
 involutory
 ipermute
+isa
 isdir
 ishandle
 ishghandle
@@ -558,8 +572,11 @@
 javamem
 Javascript
 jbig
+JConstant
 JDK
+JIS
 JIT
+JPattern
 jpeg
 JPEG
 jpg
@@ -569,8 +586,9 @@
 keybindings
 keypress
 keypressfcn
+KeyType
+kolmogorov
 Kolmogorov
-kolmogorov
 Konrod
 kron
 kruskal
@@ -589,8 +607,8 @@
 ldots
 le
 leaveInPlace
+Leftarrow
 leftarrow
-Leftarrow
 Leftrightarrow
 leftrightarrow
 leq
@@ -633,6 +651,7 @@
 Lookup
 lookup
 lookups
+lossless
 Lovato
 lpx
 lr
@@ -652,6 +671,7 @@
 Mahalanobis
 makefile
 makefiles
+makehgtform
 makeinfo
 Mandriva
 manova
@@ -660,12 +680,15 @@
 markerfacecolor
 markersize
 markerstyle
+MassSingular
 matchcase
 matlab
 MaxFunEvals
 maxima
 MaxIntervalCount
 MaxIter
+MaxOrder
+MaxStep
 mcnemar
 mdl
 meansq
@@ -676,8 +699,8 @@
 Mersenne
 meshgrid
 meshgridded
+Metafile
 metafile
-Metafile
 metafiles
 Metafont
 mex
@@ -695,8 +718,8 @@
 mkoctfile
 mldivide
 mmd
+mmm
 MMM
-mmm
 mmmm
 mmmyy
 mmmyyyy
@@ -705,16 +728,19 @@
 mput
 mrdivide
 msgbox
+MStateDependence
 MSYS
 mtimes
+Multi
 multi
-Multi
 multibyte
 multiline
 multipage
+MultipleDelimsAsOne
 multipledelimsasone
-MultipleDelimsAsOne
 MultiSelect
+multistep
+MvPattern
 mxArray
 myclass
 myfun
@@ -756,6 +782,8 @@
 nonincreasing
 nonmodal
 nonnan
+NonNegative
+nonnegativity
 nonparametric
 nonsmooth
 nonsparse
@@ -764,6 +792,7 @@
 noperm
 normals
 normcdf
+NormControl
 normest
 norminv
 normpdf
@@ -784,8 +813,8 @@
 octaverc
 ODEPACK
 ODEs
+ogg
 Ogg
-ogg
 OKString
 OLS
 onCleanup
@@ -806,31 +835,32 @@
 outliers
 OutputFcn
 outputfcn
+OutputSel
 overdetermined
 overridable
 paperorientation
+PaperPosition
 paperposition
-PaperPosition
 paperpositionmode
 papersize
+paperunits
 PaperUnits
-paperunits
 parametrically
 parseparams
 PBM
 pbm
 PBMplus
 pc
+pcg
 PCG
-pcg
 pchip
 pcr
+pcre
 PCRE
-pcre
 pcx
 PCX
+pdf
 PDF
-pdf
 pdflatex
 pearson
 pentadiagonal
@@ -841,8 +871,8 @@
 PGMRES
 PHP
 pict
+piecewise
 Piecewise
-piecewise
 pinv
 PixelRegion
 Pixmap
@@ -860,6 +890,7 @@
 polygamma
 polyval
 popupmenu
+PortAudio
 pos
 POSDEF
 POSIX
@@ -870,8 +901,8 @@
 preallocate
 preconditioner
 preconditioners
+preformatted
 Preformatted
-preformatted
 premultiplied
 Prepend
 prepended
@@ -880,8 +911,8 @@
 printf
 priori
 probit
+profiler
 Profiler
-profiler
 programmatically
 prolate
 PromptString
@@ -917,8 +948,8 @@
 quartile
 questdlg
 Quickhull
+qz
 QZ
-qz
 radian
 radians
 radices
@@ -942,6 +973,7 @@
 regressor
 Reindent
 relicensing
+RelTol
 ren
 renderer
 repelems
@@ -961,8 +993,8 @@
 restoreBG
 restorePrevious
 RET
+returnonerror
 ReturnOnError
-returnonerror
 rfloor
 RGB
 rgb
@@ -995,8 +1027,8 @@
 SHA
 shiftdim
 si
+SIGNUM
 signum
-SIGNUM
 sim
 SIMAX
 SIMD
@@ -1064,12 +1096,14 @@
 struct
 structs
 subarrays
+subclasses
+Subclasses
 subdiagonals
 subdirectories
 subdirectory
 subexpressions
+subfunction
 Subfunction
-subfunction
 Subfunctions
 subfunctions
 subinterval
@@ -1085,8 +1119,8 @@
 subprocesses
 Subprocesses
 subsasgn
+Subscripted
 subscripted
-Subscripted
 subscripting
 subseteq
 subsindex
@@ -1100,6 +1134,7 @@
 SuiteSparse
 sumsq
 SunOS
+superclass
 Supercomputing
 superdiagonal
 superdiagonals
@@ -1116,10 +1151,10 @@
 svg
 SVG
 SwitzerlandLight
+Sym
 sym
-Sym
+symamd
 SYMAMD
-symamd
 symbfact
 symrcm
 Syntaxes
@@ -1127,8 +1162,8 @@
 Tcv
 terminal's
 tex
+Texinfo
 texinfo
-Texinfo
 TextAlphaBits
 textarrow
 textbackgroundcolor
@@ -1143,9 +1178,11 @@
 textscan
 th
 ths
+ticklabels
 tif
 TikZ
 Timestamp
+timestep
 TimeStepNumber
 TimeStepSize
 tinv
@@ -1165,8 +1202,8 @@
 traceback
 TRANSA
 trapz
+TreatAsEmpty
 treatasempty
-TreatAsEmpty
 treelayout
 treeplot
 tridiagonal
@@ -1183,24 +1220,24 @@
 txi
 typedefs
 TypicalX
+ub
 UB
-ub
 uchar
 UHESS
 UI
 uibuttongroup
 Uibuttongroup
 uibuttongroups
+Uicontextmenu
 uicontextmenu
-Uicontextmenu
 uicontrol
 Uicontrol
 uicontrols
 UID
 uimenu
 uint
+Uipanel
 uipanel
-Uipanel
 uipanels
 Uipushtool
 uipushtool
@@ -1228,6 +1265,7 @@
 unifcdf
 unifinv
 UniformOutput
+UniformValues
 unifpdf
 unifrnd
 unimodal
@@ -1248,13 +1286,15 @@
 Unshared
 unsymmetric
 untabified
+uparrow
 Uparrow
-uparrow
 uplus
 userdata
 Username
 ushort
 UTC
+UTF
+ValueType
 Vandermonde
 variable's
 varphi
@@ -1265,10 +1305,10 @@
 vec
 vech
 vectorization
+Vectorize
 vectorize
-Vectorize
+vectorized
 Vectorized
-vectorized
 vectorizing
 vee
 versa
@@ -1277,10 +1317,11 @@
 verticalalignment
 vertices
 viewable
+viridis
 vorbis
 Vorbis
+Voronoi
 voronoi
-Voronoi
 waitbar
 waitbars
 wallis
@@ -1293,24 +1334,24 @@
 wblpdf
 wblrnd
 Weibull
+Welch
 welch
-Welch
 WestOutside
 whitespace
 Whitespace
 whos
 wienrnd
 Wikipedia
+Wilcoxon
 wilcoxon
-Wilcoxon
 wildcard
 wildcards
 Wildcards
 windowbuttondownfcn
 windowbuttonmotionfcn
 windowbuttonupfcn
+windowstyle
 WindowStyle
-windowstyle
 WIPO
 wireframe
 workspace
@@ -1330,6 +1371,8 @@
 xGETRF
 xGTSV
 xl
+xlim
+xlimmode
 xmax
 xmin
 xon
@@ -1356,14 +1399,15 @@
 ymax
 ymin
 ypos
+yy
 YY
-yy
 yyyy
 YYYY
 yyyymmdd
 yyyymmddTHHMMSS
 zggsvd
 Ziggurat
+zlabels
 zlib
 zlim
 zmax
--- a/doc/interpreter/external.txi	Thu Jun 08 17:46:51 2017 -0700
+++ b/doc/interpreter/external.txi	Thu Jun 08 18:24:28 2017 -0700
@@ -850,7 +850,7 @@
 @subsubsection Using Sparse Matrices in Oct-Files
 
 Most of the same operators and functions for sparse matrices that are available
-from the Octave interpeter are also available within oct-files.  The basic
+from the Octave interpreter are also available within oct-files.  The basic
 means of extracting a sparse matrix from an @code{octave_value}, and returning
 it as an @code{octave_value}, can be seen in the following example.
 
@@ -1454,7 +1454,7 @@
 @code{mxGetNumberOfElements}, and @code{mxGetNumberOfDimensions} to work with
 the dimensions of multi-dimensional arrays.  The functions @code{mxGetM}, and
 @code{mxGetN} are also available to find the number of rows and columns in a
-2-D matrix (MxN matrix).
+2-D matrix (@nospell{MxN} matrix).
 
 @node Character Strings in Mex-Files
 @subsection Character Strings in Mex-Files
--- a/doc/interpreter/install.txi	Thu Jun 08 17:46:51 2017 -0700
+++ b/doc/interpreter/install.txi	Thu Jun 08 18:24:28 2017 -0700
@@ -323,7 +323,7 @@
 solution of linear equations for sparse systems.
 
 @item SUNDIALS
-The SUite of Nonlinear and DIfferential/ALgebraic Equation Solvers
+@nospell{The SUite of Nonlinear and DIfferential/ALgebraic Equation Solvers}
 (@url{http://computation.llnl.gov/projects/sundials}) is required for
 the Ordinary Differential Equations (ODE) solvers @code{ode15i} and
 @code{ode15s}.
--- a/libinterp/corefcn/svd.cc	Thu Jun 08 17:46:51 2017 -0700
+++ b/libinterp/corefcn/svd.cc	Thu Jun 08 18:24:28 2017 -0700
@@ -385,10 +385,10 @@
 The default routine use by Octave is the newer @code{gesdd} which is based on a
 Divide-and-Conquer algorithm that is 5X faster than the alternative
 @code{gesvd}, which is based on QR factorization.  However, the new algorithm
-can use significantly more memory.  For an MxN input matrix the memory usage is
-of order O(min(M,N) ^ 2), whereas the alternative is of order O(max(M,N)).  In
-general, modern computers have abundant memory so Octave has chosen to
-prioritize speed.
+can use significantly more memory.  For an @nospell{MxN} input matrix the
+memory usage is of order O(min(M,N) ^ 2), whereas the alternative is of order
+O(max(M,N)).  In general, modern computers have abundant memory so Octave has
+chosen to prioritize speed.
 
 In addition, there have been instances in the past where some input matrices
 were not accurately decomposed by @code{gesdd}.  This appears to have been
--- a/libinterp/dldfcn/audiodevinfo.cc	Thu Jun 08 17:46:51 2017 -0700
+++ b/libinterp/dldfcn/audiodevinfo.cc	Thu Jun 08 18:24:28 2017 -0700
@@ -91,7 +91,7 @@
 If the optional argument @var{io} is 1, return information about input
 devices only.  If it is 0, return information about output devices
 only.  If @var{io} is the only argument supplied, return the number of
-intput or output devices available.
+input or output devices available.
 
 If the optional argument @var{id} is provided, return information about
 the corresponding device.
--- a/scripts/gui/uipushtool.m	Thu Jun 08 17:46:51 2017 -0700
+++ b/scripts/gui/uipushtool.m	Thu Jun 08 18:24:28 2017 -0700
@@ -32,8 +32,8 @@
 ## figure is available, but does not contain a uitoolbar, a uitoolbar will be
 ## created.
 ##
-## If @var{parent} is given then an uipushtools is created on the
-## @var{parent} uitoolbar.
+## If @var{parent} is given then a uipushtool is created on the @var{parent}
+## uitoolbar.
 ##
 ## Any provided property value pairs will override the default values of the
 ## created uipushtool object.
@@ -41,7 +41,7 @@
 ## Uipushtool properties are documented at @ref{Uipushtool Properties}.
 ##
 ## The optional return value @var{hui} is a graphics handle to the created
-## uipushobject object.
+## uipushtool object.
 ##
 ## Examples:
 ##
--- a/scripts/image/getframe.m	Thu Jun 08 17:46:51 2017 -0700
+++ b/scripts/image/getframe.m	Thu Jun 08 18:24:28 2017 -0700
@@ -24,8 +24,8 @@
 ## Without an argument, capture the current axes excluding ticklabels, title,
 ## and x/y/zlabels.  The returned structure @var{frame} has a field
 ## @code{cdata}, which contains the actual image data in the form of an
-## NxMx3 (RGB) uint8 matrix, and a field @code{colormap} which is provided for
-## @sc{matlab} compatibility but is always empty.
+## @nospell{NxMx3} (RGB) uint8 matrix, and a field @code{colormap} which is
+## provided for @sc{matlab} compatibility but is always empty.
 ##
 ## If the first argument @var{hax} is an axes handle, then capture this axes,
 ## rather than the current axes returned by @code{gca}.
--- a/scripts/optimization/fminsearch.m	Thu Jun 08 17:46:51 2017 -0700
+++ b/scripts/optimization/fminsearch.m	Thu Jun 08 18:24:28 2017 -0700
@@ -64,8 +64,8 @@
 ## @code{funcCount} containing the number of function calls to @var{fun},
 ## @code{iterations} containing the number of iteration steps,
 ## @code{algorithm} with the name of the search algorithm (always:
-## @qcode{"Nelder-Mead simplex direct search"}), and @code{message} with the
-## exit message.
+## @nospell{@qcode{"Nelder-Mead simplex direct search"}}), and @code{message}
+## with the exit message.
 ##
 ## Example:
 ##
--- a/scripts/plot/appearance/axis.m	Thu Jun 08 17:46:51 2017 -0700
+++ b/scripts/plot/appearance/axis.m	Thu Jun 08 18:24:28 2017 -0700
@@ -75,7 +75,7 @@
 ## @item @qcode{"image"}
 ## Equivalent to @qcode{"tight"} and @qcode{"equal"}.
 ##
-## @item @qcode{"vis3d"}
+## @item @nospell{@qcode{"vis3d"}}
 ## Set aspect ratio modes to @qcode{"manual"} for rotation without stretching.
 ## @end table
 ##