Mercurial > hg > octave-nkf
changeset 16816:12005245b645
doc: Periodic grammarcheck of documentation.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/contrib.txi, doc/interpreter/diagperm.txi,
doc/interpreter/errors.txi, doc/interpreter/install.txi,
doc/interpreter/sparse.txi, libinterp/corefcn/ellipj.cc,
libinterp/corefcn/mappers.cc, libinterp/corefcn/regexp.cc,
libinterp/corefcn/tril.cc, libinterp/dldfcn/__init_fltk__.cc,
libinterp/dldfcn/fftw.cc, libinterp/interpfcn/dirfns.cc,
libinterp/interpfcn/input.cc, libinterp/octave-value/ov-fcn-inline.cc,
libinterp/octave-value/ov-struct.cc, scripts/@ftp/cd.m,
scripts/general/interp1.m, scripts/general/num2str.m, scripts/image/ind2rgb.m,
scripts/image/rgb2ind.m, scripts/io/importdata.m, scripts/io/textread.m,
scripts/java/javamem.m, scripts/linear-algebra/condest.m,
scripts/linear-algebra/onenormest.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/getfield.m, scripts/miscellaneous/setfield.m,
scripts/plot/area.m, scripts/plot/pcolor.m, scripts/plot/stairs.m,
scripts/set/powerset.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/specfun/ellipke.m,
scripts/special-matrix/gallery.m, scripts/strings/strjoin.m,
scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m,
scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m,
scripts/testfun/__run_test_suite__.m: grammarcheck documentation.
line wrap: on
line diff
--- a/doc/interpreter/basics.txi +++ b/doc/interpreter/basics.txi @@ -272,7 +272,7 @@ @noindent Note that this does not enable the @code{Octave:matlab-incompatible} warning, which you might want if you want to be told about writing code -that works in Octave but not Matlab (@pxref{docXwarning}, +that works in Octave but not @sc{matlab} (@pxref{docXwarning}, @pxref{docXwarning_ids}). @item --verbose
--- a/doc/interpreter/container.txi +++ b/doc/interpreter/container.txi @@ -38,7 +38,7 @@ @cindex structures @cindex data structures -Octave includes support for organizing data in structures. The current +Octave includes support for organizing data in structures. The current implementation uses an associative array with indices limited to strings, but the syntax is more like C-style structures. @@ -392,7 +392,7 @@ @noindent Dynamic indexing also allows you to use arbitrary strings, not merely -valid Octave identifiers (note that this does not work on @sc{Matlab}): +valid Octave identifiers (note that this does not work on @sc{matlab}): @example @group @@ -410,7 +410,7 @@ @noindent The warning id @code{Octave:matlab-incompatible} can be enabled to warn -about this usage. @xref{docXwarning_ids}. +about this usage. @xref{docXwarning_ids}. More realistically, all of the functions that operate on strings can be used to build the correct field name before it is entered into the data structure.
--- a/doc/interpreter/contrib.txi +++ b/doc/interpreter/contrib.txi @@ -89,13 +89,15 @@ @end example You may want to get familiar with Mercurial queues to manage your -changesets. For working with queues you have to activate the extension +changesets. For working with queues you have to activate the extension mq with the following entry in Mercurials config file @file{.hgrc} (or @file{Mercurial.ini} on Windows): @example +@group [extensions] mq= +@end group @end example Here is a slightly more complex example using Mercurial @@ -138,17 +140,20 @@ The following entries in the @file{.hgrc} are recommended @example +@group [extensions] graphlog= color= progress= pager= +@end group @end example For the colour extension, default colour and formatting of @code{hg status} can be modified by @example +@group [color] status.modified = magenta bold status.added = green bold @@ -156,13 +161,15 @@ status.deleted = cyan bold status.unknown = black bold status.ignored = black bold +@end group @end example Sometimes a few further improvements for the pager extension are -necessary. The following options should not be enabled unless paging +necessary. The following options should not be enabled unless paging isn't working correctly: @example +@group [pager] # Some options for the less pager, see less(1) for their meaning. pager = LESS='FSRX' less @@ -171,11 +178,12 @@ # for them attend = tags, help, annotate, cat, diff, export, status, \ outgoing, incoming +@end group @end example Enabling the described extensions should immediately lead to a difference -when using the command line version of hg. Of these options, the only one -that enables a new command is graphlog. It is recommanded that you use the +when using the command line version of hg. Of these options, the only one +that enables a new command is graphlog. It is recommanded that you use the command @code{hg glog} instead of @code{hg log} for a better feel what commits are being based on.
--- a/doc/interpreter/diagperm.txi +++ b/doc/interpreter/diagperm.txi @@ -519,6 +519,7 @@ @item permutation matrix * matrix is equivalent to permuting rows @end itemize + all of these natural mathematical truths would be invalidated by treating assumed zeros as numerical ones.
--- a/doc/interpreter/errors.txi +++ b/doc/interpreter/errors.txi @@ -189,7 +189,7 @@ "Octave" is used for Octave's own errors. Any other string is available as a namespace for user's own errors. -The next example counts indexing errors. The errors are catched using the +The next example counts indexing errors. The errors are catched using the field identifier of the structure returned by the function @code{lasterror}. @example
--- a/doc/interpreter/install.txi +++ b/doc/interpreter/install.txi @@ -276,7 +276,7 @@ @code{qrinsert}, @code{qrshift}, and @code{qrupdate}. @item QScintilla -Source code highlighter and manipulator; a Qt port of Scintilla +Source code highlighter and manipulator; a Qt port of Scintilla (@url{http://www.riverbankcomputing.co.uk/software/qscintilla}). QScintilla is used for syntax highlighting and code completion in the GUI.
--- a/doc/interpreter/sparse.txi +++ b/doc/interpreter/sparse.txi @@ -89,13 +89,13 @@ easy to grasp, but requires more storage than is strictly needed. The storage technique used within Octave is the compressed column -format. It is similar to the Yale format. +format. It is similar to the Yale format. @footnote{@url{http://en.wikipedia.org/wiki/Sparse_matrix#Yale_format}} In this format the position of each element in a row and the data are -stored as previously. However, if we assume that all elements in the +stored as previously. However, if we assume that all elements in the same column are stored adjacent in the computers memory, then we only need to store information on the number of non-zero elements in each -column, rather than their positions. Thus assuming that the matrix has +column, rather than their positions. Thus assuming that the matrix has more non-zero elements than there are columns in the matrix, we win in terms of the amount of memory used. @@ -800,16 +800,16 @@ @end enumerate The band density is defined as the number of non-zero values in the band -divided by the total number of values in the full band. The banded +divided by the total number of values in the full band. The banded matrix solvers can be entirely disabled by using @dfn{spparms} to set @code{bandden} to 1 (i.e., @code{spparms ("bandden", 1)}). The QR@tie{}solver factorizes the problem with a Dulmage-Mendelsohn decomposition, to separate the problem into blocks that can be treated as over-determined, multiple well determined blocks, and a final -over-determined block. For matrices with blocks of strongly connected +over-determined block. For matrices with blocks of strongly connected nodes this is a big win as LU@tie{}decomposition can be used for many -blocks. It also significantly improves the chance of finding a solution +blocks. It also significantly improves the chance of finding a solution to over-determined problems rather than just returning a vector of @dfn{NaN}'s.
--- a/libinterp/corefcn/ellipj.cc +++ b/libinterp/corefcn/ellipj.cc @@ -149,9 +149,9 @@ @var{m} must conform and the results will be the same size.\n\ \n\ The value of @var{u} may be complex.\n\ -The value of @var{m} must be 0 <= m <= 1.\n\ +The value of @var{m} must be 0 @leq{} m @leq{} 1.\n\ \n\ -@var{tol} is currently ignored (@sc{Matlab} uses this to allow faster,\n\ +@var{tol} is currently ignored (@sc{matlab} uses this to allow faster,\n\ less accurate approximation).\n\ \n\ If requested, @var{err} contains the following status information\n\ @@ -160,6 +160,7 @@ @enumerate 0\n\ @item\n\ Normal return.\n\ +\n\ @item\n\ Error---no computation, algorithm termination condition not met,\n\ return @code{NaN}.\n\
--- a/libinterp/corefcn/mappers.cc +++ b/libinterp/corefcn/mappers.cc @@ -1884,7 +1884,7 @@ @deftypefn {Mapping Function} {} signbit (@var{x})\n\ Return logical true if the value of @var{x} has its sign bit set.\n\ Otherwise return logical false. This behavior is consistent with the other\n\ -logical functions. See@ref{Logical Values}. The behavior differs from the\n\ +logical functions. See@ref{Logical Values}. The behavior differs from the\n\ C language function which returns non-zero if the sign bit is set.\n\ \n\ This is not the same as @code{x < 0.0}, because IEEE 754 floating point\n\
--- a/libinterp/corefcn/regexp.cc +++ b/libinterp/corefcn/regexp.cc @@ -1305,8 +1305,9 @@ \n\ Implementation Note: For compatibility with @sc{matlab}, ordinary escape\n\ sequences (e.g., \"\\n\" => newline) are processed in both @var{pat}\n\ -and @var{repstr} regardless of whether they were defined within single quotes. Use a second backslash to stop interpolation of the escape sequence (e.g.,\n\ -\"\\\\n\") or use the @code{regexptranslate} function.\n\ +and @var{repstr} regardless of whether they were defined within single\n\ +quotes. Use a second backslash to stop interpolation of the escape sequence\n\ +(e.g., \"\\\\n\") or use the @code{regexptranslate} function.\n\ @seealso{regexp, regexpi, strrep}\n\ @end deftypefn") {
--- a/libinterp/corefcn/tril.cc +++ b/libinterp/corefcn/tril.cc @@ -356,9 +356,9 @@ The default value of @var{k} is zero, so that @code{triu} and\n\ @code{tril} normally include the main diagonal as part of the result.\n\ \n\ -If the value of @var{k} is nonzero integer, the selection of elements\ -starts at an offset of @var{k} diagonals above or below the main\ -diagonal; above for positive @var{k} and below for negative @var{k}.\ +If the value of @var{k} is nonzero integer, the selection of elements\n\ +starts at an offset of @var{k} diagonals above or below the main\n\ +diagonal; above for positive @var{k} and below for negative @var{k}.\n\ \n\ The absolute value of @var{k} must not be greater than the number of\n\ sub-diagonals or super-diagonals.\n\
--- a/libinterp/dldfcn/__init_fltk__.cc +++ b/libinterp/dldfcn/__init_fltk__.cc @@ -2071,7 +2071,7 @@ DEFUN_DLD (__have_fltk__, , , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{FLTK_available} =} __have_fltk__ ()\n\ +@deftypefn {Loadable Function} {@var{FLTK_available} =} __have_fltk__ ()\n\ Undocumented internal function.\n\ @end deftypefn") {
--- a/libinterp/dldfcn/fftw.cc +++ b/libinterp/dldfcn/fftw.cc @@ -120,8 +120,9 @@ fftw (\"threads\", @var{NTHREADS})\n\ @end example\n\ \n\ -Note that octave must be compiled with multi-threaded FFTW support for this feature.\n\ -The number of processors available to the current process is used per default.\n\ +Note that octave must be compiled with multi-threaded @sc{fftw} support for\n\ +this feature. The number of processors available to the current process is\n\ +used per default.\n\ \n\ @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\ @end deftypefn")
--- a/libinterp/interpfcn/dirfns.cc +++ b/libinterp/interpfcn/dirfns.cc @@ -563,6 +563,7 @@ @table @code\n\ @item *\n\ matches any string, including the null string,\n\ +\n\ @item ?\n\ matches any single character, and\n\ \n\
--- a/libinterp/interpfcn/input.cc +++ b/libinterp/interpfcn/input.cc @@ -1128,8 +1128,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{id} =} add_input_event_hook (@var{fcn})\n\ @deftypefnx {Built-in Function} {@var{id} =} add_input_event_hook (@var{fcn}, @var{data})\n\ -Add the named function or function handle @var{fcn} to the list of functions to call\n\ -periodically when Octave is waiting for input. The function should\n\ +Add the named function or function handle @var{fcn} to the list of functions\n\ +to call periodically when Octave is waiting for input. The function should\n\ have the form\n\ \n\ @example\n\ @@ -1177,7 +1177,7 @@ DEFUN (remove_input_event_hook, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} remove_input_event_hook (@var{name})\n\ +@deftypefn {Built-in Function} {} remove_input_event_hook (@var{name})\n\ @deftypefnx {Built-in Function} {} remove_input_event_hook (@var{fcn_id})\n\ Remove the named function or function handle with the given identifier\n\ from the list of functions to call periodically when Octave is waiting\n\
--- a/libinterp/octave-value/ov-fcn-inline.cc +++ b/libinterp/octave-value/ov-fcn-inline.cc @@ -645,7 +645,7 @@ be noted that i, and j are ignored as arguments due to the\n\ ambiguity between their use as a variable or their use as an inbuilt\n\ constant. All arguments followed by a parenthesis are considered\n\ -to be functions. If no arguments are found, a function taking a single\n\ +to be functions. If no arguments are found, a function taking a single\n\ argument named @code{x} will be created.\n\ \n\ If the second and subsequent arguments are character strings,\n\
--- a/libinterp/octave-value/ov-struct.cc +++ b/libinterp/octave-value/ov-struct.cc @@ -1751,7 +1751,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} struct (@var{field1}, @var{value1}, @var{field2}, @var{value2}, @dots{})\n\ \n\ -Create a scalar or array structure and initialize its values. The\n\ +Create a scalar or array structure and initialize its values. The\n\ @var{field1}, @var{field2}, @dots{} variables are strings giving the\n\ names of the fields and the @var{value1}, @var{value2}, @dots{}\n\ variables can be any type.\n\ @@ -1764,8 +1764,8 @@ \n\ If the argument is an object, return the underlying struct.\n\ \n\ -Observe that the syntax is optimized for struct @strong{arrays}. Consider the\n\ -following examples:\n\ +Observe that the syntax is optimized for struct @strong{arrays}. Consider\n\ +the following examples:\n\ \n\ @example\n\ @group\n\ @@ -1789,11 +1789,11 @@ @end example\n\ \n\ @noindent\n\ -The first case is an ordinary scalar struct, one field, one value. The\n\ +The first case is an ordinary scalar struct, one field, one value. The\n\ second produces an empty struct array with one field and no values, since\n\ -s being passed an empty cell array of struct array values. When the value is\n\ +s being passed an empty cell array of struct array values. When the value is\n\ a cell array containing a single entry, this becomes a scalar struct with\n\ -that single entry as the value of the field. That single entry happens\n\ +that single entry as the value of the field. That single entry happens\n\ to be an empty cell array.\n\ \n\ Finally, if the value is a non-scalar cell array, then @code{struct}\n\
--- a/scripts/@ftp/cd.m +++ b/scripts/@ftp/cd.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cd (@var{f}) +## @deftypefn {Function File} {} cd (@var{f}) ## @deftypefnx {Function File} {} cd (@var{f}, @var{path}) ## Get or set the remote directory on the FTP connection @var{f}. ##
--- a/scripts/general/interp1.m +++ b/scripts/general/interp1.m @@ -68,7 +68,7 @@ ## Duplicate points in @var{x} specify a discontinuous interpolant. There ## may be at most 2 consecutive points with the same value. ## If @var{x} is increasing, the default discontinuous interpolant is -## right-continuous. If @var{x} is decreasing, the default discontinuous +## right-continuous. If @var{x} is decreasing, the default discontinuous ## interpolant is left-continuous. ## The continuity condition of the interpolant may be specified by using ## the options, "-left" or "-right", to select a left-continuous
--- a/scripts/general/num2str.m +++ b/scripts/general/num2str.m @@ -53,7 +53,7 @@ ## ## Notes: ## -## For Matlab compatibility, leading spaces are stripped before returning +## For @sc{matlab} compatibility, leading spaces are stripped before returning ## the string. ## ## The @code{num2str} function is not very flexible. For better control
--- a/scripts/image/ind2rgb.m +++ b/scripts/image/ind2rgb.m @@ -31,7 +31,7 @@ ## channels). Alternatively, the individual red, green, and blue color matrices ## of size MxN may be returned. ## -## Multidimensional indexed images (of size MxNx1xK) are also supported. +## Multi-dimensional indexed images (of size MxNx1xK) are also supported. ## ## @seealso{rgb2ind, ind2gray, hsv2rgb, ntsc2rgb} ## @end deftypefn
--- a/scripts/image/rgb2ind.m +++ b/scripts/image/rgb2ind.m @@ -36,16 +36,16 @@ ## Convert an image in red-green-blue (RGB) color space to an indexed image. ## ## The input image @var{rgb} must be an N-dimensional RGB image -## (MxNxO...x3 array) where M,N,O... are the image dimensions, and the +## (MxNxO@dots{}x3 array) where M,N,O@dots{} are the image dimensions, and the ## final dimension contains the values in the red, green and blue -## channels. Alternatively, the red, green and blue color channels can +## channels. Alternatively, the red, green and blue color channels can ## be input as separate arrays @var{R}, @var{G} and @var{B}. ## ## The input @var{map} defines the colormap to be used. Alternatively, ## @var{n} or @var{tol} may be used to define the maximum number of ## colors to use in an automatically generated colormap. @var{n} is ## related to @var{tol} by: @var{n} = (floor (1/@var{tol}) + 1)^3; -## @var{tol} must be >0 and <=1. +## @var{tol} must be >0 and @leq{}1. ## ## @var{dither_option} is a string which enables or disables dithering: ## 'dither' (default) or 'nodither'.
--- a/scripts/io/importdata.m +++ b/scripts/io/importdata.m @@ -27,19 +27,21 @@ ## Importing the contents of file @var{fname} into workspace. ## ## Input parameters: +## ## @itemize ## @item @var{fname} ## The file name for the file to import. ## ## @item @var{delimiter} -## The character separating columns of data. Use @code{\t} for tab. +## The character separating columns of data. Use @code{\t} for tab. ## (Only valid for ascii files) ## ## @item @var{header_rows} -## Number of header rows before the data begins. (Only valid for ascii files) +## Number of header rows before the data begins. (Only valid for ascii files) ## @end itemize ## ## Different file types are supported: +## ## @itemize ## @item Ascii table ## @@ -48,7 +50,7 @@ ## ## @item Image file ## -## @item @sc{Matlab} file +## @item @sc{matlab} file ## ## @item Spreadsheet files (depending on external software) ##
--- a/scripts/io/textread.m +++ b/scripts/io/textread.m @@ -47,7 +47,7 @@ ## If the format string is empty (not: omitted) and the file contains only ## numeric data (excluding headerlines), textread will return a rectangular ## matrix with the number of columns matching the number of numeric fields on -## the first data line of the file. Empty fields are returned as zero values. +## the first data line of the file. Empty fields are returned as zero values. ## ## @seealso{strread, load, dlmread, fscanf, textscan} ## @end deftypefn
--- a/scripts/java/javamem.m +++ b/scripts/java/javamem.m @@ -35,7 +35,8 @@ ## @file{java.opts}. The directory where this file resides is ## determined by the environment variable @w{@env{OCTAVE_JAVA_DIR}}. ## If unset, the directory where @file{javaaddpath.m} resides is used instead -## (typically @file{@env{OCTAVE_HOME}/share/octave/@env{OCTAVE_VERSION}/m/java/} +## (typically +## @file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/} ## ## @file{java.opts} is a plain text file with one option per line. The ## default initial memory size and default maximum memory size (which
--- a/scripts/linear-algebra/condest.m +++ b/scripts/linear-algebra/condest.m @@ -56,6 +56,7 @@ ## approximate null vector. ## ## References: +## ## @itemize ## @item ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm
--- a/scripts/linear-algebra/onenormest.m +++ b/scripts/linear-algebra/onenormest.m @@ -38,6 +38,7 @@ ## iterations is limited to 10 and is at least 2. ## ## References: +## ## @itemize ## @item ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm
--- a/scripts/miscellaneous/error_ids.m +++ b/scripts/miscellaneous/error_ids.m @@ -40,7 +40,7 @@ ## Indicates that memory couldn't be allocated. ## ## @item Octave:undefined-function -## Indicates a call to a function that is not defined. The function may +## Indicates a call to a function that is not defined. The function may ## exist but Octave is unable to find it in the search path. ## ## @end table
--- a/scripts/miscellaneous/getfield.m +++ b/scripts/miscellaneous/getfield.m @@ -18,9 +18,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{val}] =} getfield (@var{s}, @var{field}) +## @deftypefn {Function File} {[@var{val}] =} getfield (@var{s}, @var{field}) ## @deftypefnx {Function File} {[@var{val}] =} getfield (@var{s}, @var{idx1}, @var{field1}, @var{idx2}, @var{field2}, @dots{}) -## Extract a field from a structure (or a nested structure). The syntax +## Extract a field from a structure (or a nested structure). The syntax ## is the same as @code{setfield}, except it omits the final @var{val} ## argument, returning this value instead of setting it. ##
--- a/scripts/miscellaneous/setfield.m +++ b/scripts/miscellaneous/setfield.m @@ -18,10 +18,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{s} =} setfield (@var{s}, @var{field}, @var{val}) +## @deftypefn {Function File} {@var{s} =} setfield (@var{s}, @var{field}, @var{val}) ## @deftypefnx {Function File} {@var{s} =} setfield (@var{s}, @var{idx1}, @var{field1}, @var{idx2}, @var{field2}, @dots{}, @var{val}) ## -## Set a field member @var{field} in a structure @var{s} equal to @var{val}. For example: +## Set a field member @var{field} in a structure @var{s} equal to @var{val}. +## For example: ## ## @example ## @group @@ -39,10 +40,10 @@ ## ## @noindent ## Note that ordinary structure syntax @code{@var{s}.foo bar = 42} cannot be -## used here, as the field name is not a valid Octave identifier. Using -## arbitrary strings for field name is incompatible with @sc{Matlab}, so +## used here, as the field name is not a valid Octave identifier. Using +## arbitrary strings for field name is incompatible with @sc{matlab}, so ## this usage will warn if the @code{Octave:matlab-incompatible} warning -## is set. @xref{docXwarning_ids}. +## is set. @xref{docXwarning_ids}. ## ## With the second calling form, set a field on a structure array, ## possibly nested, with successive nested indices @var{idx1}, @@ -66,7 +67,7 @@ ## @end example ## ## Here we first have an ordinary structure array with one field -## @code{baz} set to 42. Then we set another field in a nested scalar structure +## @code{baz} set to 42. Then we set another field in a nested scalar structure ## indexing with two single cells containing the unique desired indices. ## ## Finally an example with nested structure arrays,
--- a/scripts/plot/area.m +++ b/scripts/plot/area.m @@ -25,9 +25,9 @@ ## @deftypefnx {Function File} {} area (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} area (@dots{}) ## Area plot of the columns of @var{y}. This shows the -## contributions of each column value to the row sum. It is functionally similar to -## @code{plot (@var{x}, cumsum (@var{y}, 2))}, except that the area under -## the curve is shaded. +## contributions of each column value to the row sum. It is functionally +## similar to @code{plot (@var{x}, cumsum (@var{y}, 2))}, except that the +## area under the curve is shaded. ## ## If the @var{x} argument is omitted it defaults to ## @code{1 : rows (@var{y})}. A value @var{lvl} can be defined that determines @@ -44,10 +44,12 @@ ## Example: Verify identity sin^2 + cos^2 = 1 ## ## @example +## @group ## t = linspace (0, 2*pi, 100)'; ## y = [sin(t).^2, cos(t).^2)]; ## area (t, y); ## legend ('sin^2', 'cos^2', 'location', 'NorthEastOutside'); +## @end group ## @end example ## @seealso{plot, patch} ## @end deftypefn
--- a/scripts/plot/pcolor.m +++ b/scripts/plot/pcolor.m @@ -19,11 +19,12 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} pcolor (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} pcolor (@var{c}) -## Produce a density plot for matrices @var{x} and @var{y} from @code{meshgrid},## and a matrix @var{c} corresponding to the @var{x} and @var{y} coordinates of -## the mesh's vertices. If @var{x} and @var{y} are vectors, then a typical -## vertex is (@var{x}(j), @var{y}(i), @var{c}(i,j)). Thus, columns of @var{c} -## correspond to different @var{x} values and rows of @var{c} correspond -## to different @var{y} values. +## Produce a density plot for matrices @var{x} and @var{y} from +## @code{meshgrid}, and a matrix @var{c} corresponding to the @var{x} and +## @var{y} coordinates of the mesh's vertices. If @var{x} and @var{y} are +## vectors, then a typical vertex is (@var{x}(j), @var{y}(i), @var{c}(i,j)). +## Thus, columns of @var{c} correspond to different @var{x} values and rows +## of @var{c} correspond to different @var{y} values. ## ## The @code{colormap} is scaled to the extents of @var{c}. ## Limits may be placed on the color axis by the command @code{caxis}, or by
--- a/scripts/plot/stairs.m +++ b/scripts/plot/stairs.m @@ -30,7 +30,7 @@ ## and the x coordinates are taken to be the indices of the elements. ## ## If one output argument is requested, return a graphics handle to the -## created plot. If two output arguments are specified, the data are generated +## created plot. If two output arguments are specified, the data are generated ## but not plotted. For example, ## ## @example
--- a/scripts/set/powerset.m +++ b/scripts/set/powerset.m @@ -26,7 +26,7 @@ ## ## With the optional second argument @code{"rows"}, each row of the set @var{a} ## is considered one element of the set. As a result, @var{a} must then be a -## numerical 2D matrix. +## numerical 2-D matrix. ## ## @seealso{unique, union, setxor, setdiff, ismember} ## @end deftypefn
--- a/scripts/sparse/bicg.m +++ b/scripts/sparse/bicg.m @@ -54,6 +54,7 @@ ## ## @item 3: the algorithm reached stagnation ## @end itemize +## ## (the value 2 is unused but skipped for compatibility). ## ## @item @var{relres} is the final value of the relative residual.
--- a/scripts/sparse/bicgstab.m +++ b/scripts/sparse/bicgstab.m @@ -56,6 +56,7 @@ ## ## @item 3: the algorithm reached stagnation ## @end itemize +## ## (the value 2 is unused but skipped for compatibility). ## ## @item @var{relres} is the final value of the relative residual.
--- a/scripts/sparse/cgs.m +++ b/scripts/sparse/cgs.m @@ -56,6 +56,7 @@ ## ## @item 3: the algorithm reached stagnation ## @end itemize +## ## (the value 2 is unused but skipped for compatibility). ## ## @item @var{relres} is the final value of the relative residual.
--- a/scripts/specfun/ellipke.m +++ b/scripts/specfun/ellipke.m @@ -25,9 +25,9 @@ ## Compute complete elliptic integral of the first K(@var{m}) and second ## E(@var{m}) kind. ## -## @var{m} is either real array or scalar with 0 <= m <= 1. +## @var{m} is either real array or scalar with 0 @leq{} m @leq{} 1. ## -## @var{tol} is currently ignored (@sc{Matlab} uses this to allow faster, +## @var{tol} is currently ignored (@sc{matlab} uses this to allow faster, ## less accurate approximation). ## ## Ref: Abramowitz, Milton and Stegun, Irene A. Handbook of Mathematical
--- a/scripts/special-matrix/gallery.m +++ b/scripts/special-matrix/gallery.m @@ -50,7 +50,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{c} =} gallery ("circul", @var{v}) +## @deftypefn {Function File} {@var{c} =} gallery ("circul", @var{v}) ## Create a circulant matrix. ## ## @end deftypefn @@ -81,8 +81,8 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {[@var{c},@var{d}, @var{e}] =} gallery ("dorr", @var{n}) -## @deftypefnx {Function File} {[@var{c},@var{d}, @var{e}] =} gallery ("dorr", @var{n}, @var{theta}) +## @deftypefn {Function File} {[@var{c}, @var{d}, @var{e}] =} gallery ("dorr", @var{n}) +## @deftypefnx {Function File} {[@var{c}, @var{d}, @var{e}] =} gallery ("dorr", @var{n}, @var{theta}) ## @deftypefnx {Function File} {@var{a} =} gallery ("dorr", @dots{}) ## Create a diagonally dominant, ill conditioned, tridiagonal matrix. ## @@ -94,7 +94,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("fiedler", @var{c}) +## @deftypefn {Function File} {@var{a} =} gallery ("fiedler", @var{c}) ## Create a symmetric Fiedler matrix. ## ## @end deftypefn @@ -112,7 +112,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{c} =} gallery ("gcdmat", @var{n}) +## @deftypefn {Function File} {@var{c} =} gallery ("gcdmat", @var{n}) ## Create a greatest common divisor matrix. ## ## @var{c} is an @var{n}-by-@var{n} matrix whose values correspond to the @@ -135,7 +135,8 @@ ## ## @deftypefn {Function File} {@var{a} =} gallery ("hanowa", @var{n}) ## @deftypefnx {Function File} {@var{a} =} gallery ("hanowa", @var{n}, @var{d}) -## Create a matrix whose eigenvalues lie on a vertical line in the complex plane. +## Create a matrix whose eigenvalues lie on a vertical line in the complex +## plane. ## ## @end deftypefn ## @@ -151,7 +152,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("invol", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("invol", @var{n}) ## Create an involutory matrix. ## ## @end deftypefn @@ -194,22 +195,22 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("lehmer", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("lehmer", @var{n}) ## Create a Lehmer matrix (symmetric positive definite). ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{t} =} gallery ("lesp", @var{n}) +## @deftypefn {Function File} {@var{t} =} gallery ("lesp", @var{n}) ## Create a tridiagonal matrix with real, sensitive eigenvalues. ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("lotkin", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("lotkin", @var{n}) ## Create a Lotkin matrix. ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("minij", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("minij", @var{n}) ## Create a symmetric positive definite matrix MIN(i,j). ## ## @end deftypefn @@ -220,7 +221,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {[@var{a}, @var{t}] =} gallery ("neumann", @var{n}) +## @deftypefn {Function File} {[@var{a}, @var{t}] =} gallery ("neumann", @var{n}) ## Create a singular matrix from the discrete Neumann problem (sparse). ## ## @end deftypefn @@ -231,7 +232,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("parter", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("parter", @var{n}) ## Create a Parter matrix (a Toeplitz matrix with singular values near pi). ## ## @end deftypefn @@ -242,7 +243,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("poisson", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("Poisson", @var{n}) ## Create a block tridiagonal matrix from Poisson's equation (sparse). ## ## @end deftypefn @@ -253,7 +254,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{h} =} gallery ("randhess", @var{x}) +## @deftypefn {Function File} {@var{h} =} gallery ("randhess", @var{x}) ## Create a random, orthogonal upper Hessenberg matrix. ## ## @end deftypefn @@ -273,18 +274,18 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("redheff", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("redheff", @var{n}) ## Create a zero and ones matrix of Redheffer associated with the Riemann ## hypothesis. ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("riemann", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("riemann", @var{n}) ## Create a matrix associated with the Riemann hypothesis. ## ## @end deftypefn ## -## @deftypefn {Function File} {@var{a} =} gallery ("ris", @var{n}) +## @deftypefn {Function File} {@var{a} =} gallery ("ris", @var{n}) ## Create a symmetric Hankel matrix. ## ## @end deftypefn @@ -333,7 +334,7 @@ ## ## @end deftypefn ## -## @deftypefn {Function File} {[@var{a}, @var{b}] =} gallery ("wilk", @var{n}) +## @deftypefn {Function File} {[@var{a}, @var{b}] =} gallery ("wilk", @var{n}) ## Create various specific matrices devised/discussed by Wilkinson. ## ## @end deftypefn
--- a/scripts/strings/strjoin.m +++ b/scripts/strings/strjoin.m @@ -18,20 +18,20 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{str} =} strjoin (@var{cstr}) +## @deftypefn {Function File} {@var{str} =} strjoin (@var{cstr}) ## @deftypefnx {Function File} {@var{str} =} strjoin (@var{cstr}, @var{delimiter}) -## Joins the elements of the cell-string array, @var{cstr}, into a single +## Join the elements of the cell-string array, @var{cstr}, into a single ## string. ## ## If no @var{delimiter} is specified, the elements of @var{cstr} ## seperated by a space. ## ## If @var{delimiter} is specified as a string, the cell-string array is -## joined using the string. Escape sequences are supported. +## joined using the string. Escape sequences are supported. ## ## If @var{delimiter} is a cell-string array whose length is one less ## than @var{cstr}, then the elemennts of @var{cstr} are joined by -## interleaving the cell-string elements of @var{delimiter}. Escape +## interleaving the cell-string elements of @var{delimiter}. Escape ## sequences are not supported. ## ## @example
--- a/scripts/strings/strsplit.m +++ b/scripts/strings/strsplit.m @@ -34,7 +34,6 @@ ## Example: ## ## @example -## @group ## strsplit ("a b c") ## @result{} ## @{ @@ -69,7 +68,6 @@ ## [1,5] = c ## @} ## -## @end group ## @end example ## ## Supported @var{name}/@var{value} pair arguments are; @@ -77,15 +75,15 @@ ## @itemize ## @item @var{collapsedelimiters} may take the value of @var{true} or ## @var{false} with the default being @var{false}. +## ## @item @var{delimitertype} may take the value of @code{simple} or -## @code{regularexpression}. The default is @var{delimitertype} is +## @code{regularexpression}. The default is @var{delimitertype} is ## @code{simple}. ## @end itemize ## ## Example: ## ## @example -## @group ## strsplit ("a foo b,bar c", ",|\\s|foo|bar", "delimitertype", "regularexpression") ## @result{} ## @{ @@ -122,7 +120,6 @@ ## [1,5] = ## [1,6] = c ## @} -## @end group ## @end example ## ## @seealso{ostrsplit, strjoin, strtok, regexp}
--- a/scripts/testfun/__have_feature__.m +++ b/scripts/testfun/__have_feature__.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __have_feature__ (feature) +## @deftypefn {Function File} {} __have_feature__ (feature) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/testfun/__printf_assert__.m +++ b/scripts/testfun/__printf_assert__.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __printf_assert__ (@dots{}) +## @deftypefn {Function File} {} __printf_assert__ (@dots{}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/testfun/__prog_output_assert__.m +++ b/scripts/testfun/__prog_output_assert__.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __prog_output_assert__ (@var{str}) +## @deftypefn {Function File} {} __prog_output_assert__ (@var{str}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/testfun/__run_test_suite__.m +++ b/scripts/testfun/__run_test_suite__.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}) +## @deftypefn {Function File} {} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}) ## Undocumented internal function. ## @end deftypefn