Mercurial > octave
changeset 30357:c33284f08090
maint: merge stable to default.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 24 Nov 2021 20:26:59 -0800 |
parents | e27be169feff (current diff) 95c2ac7b43d6 (diff) |
children | 045d93c84fe7 |
files | libinterp/corefcn/__isprimelarge__.cc libinterp/corefcn/input.cc libinterp/corefcn/qr.cc libinterp/octave-value/ov.cc |
diffstat | 24 files changed, 181 insertions(+), 162 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi Wed Nov 24 13:19:49 2021 -0500 +++ b/doc/interpreter/plot.txi Wed Nov 24 20:26:59 2021 -0800 @@ -1076,23 +1076,25 @@ @node @code{latex} interpreter @subsubsection @code{latex} interpreter @anchor{XREFlatexinterpreter} -The @qcode{"latex"} interpreter only works if an external LaTeX tool chain is -present. Three binaries are needed: @code{latex}, @code{dvipng}, and +The @qcode{"latex"} interpreter only works if an external @LaTeX{} tool chain +is present. Three binaries are needed: @code{latex}, @code{dvipng}, and @code{dvisvgm}. If those binaries are installed but not on the path, one can still provide their respective path using the following environment variables: -OCTAVE_LATEX_BINARY, OCTAVE_DVIPNG_BINARY, and OCTAVE_DVISVG_BINARY. +@w{@env{OCTAVE_LATEX_BINARY}}, @w{@env{OCTAVE_DVIPNG_BINARY}}, and +@w{@env{OCTAVE_DVISVG_BINARY}}. Note that Octave does not parse or validate the text strings when in @qcode{"latex"} mode---it is the responsibility of the programmer to generate valid strings which may include wrapping sections that should appear in Math mode with @qcode{'$'} characters. -See e.g. @url{https://www.latex-project.org/help/documentation/} for -documentation about LaTeX typesetting. +See, for example, @url{https://www.latex-project.org/help/documentation/} for +documentation about @LaTeX{} typesetting. For debugging purpose, a convenience environment variable, -OCTAVE_LATEX_DEBUG_FLAG, can be set to trigger more verbose output when Octave -fails to have a given text compiled by an external latex engine. E.g. -@qcode{"x^2"} is not a valid LaTeX string and the following example should fail +@w{@env{OCTAVE_LATEX_DEBUG_FLAG}}, can be set to trigger more verbose output +when Octave fails to have a given text compiled by an external @LaTeX{} engine. +For example, @qcode{"x^2"} is not a valid @LaTeX{} string and the following +example should fail @example @group @@ -1103,8 +1105,8 @@ @end group @end example -Searching the terminal output you should find some helpful info about the origin -of the failure: +Searching the terminal output you should find some helpful info about the +origin of the failure: @example @group @@ -1120,7 +1122,7 @@ @end group @end example -If no usable latex tool chain is found at the first text rendering, using +If no usable @LaTeX{} tool chain is found at the first text rendering, using the @qcode{"latex"} interpreter is equivalent to @qcode{"none"}. @node Printing and Saving Plots @@ -1152,18 +1154,21 @@ such text. In general, the @qcode{"tex"} interpreter (default) is the best all-around performer for both on-screen display and printing. However, for the reproduction of complicated text formulas the @qcode{"latex"} interpreter is -preferred. When printing with the @code{-painters} renderer, the default for +preferred. When printing with the @option{-painters} renderer, the default for all vector formats, two options may be considered: + @itemize @bullet @item -Use the @option{-svgconvert} option to allow for rendering LaTeX formulas. Note -that the glyph are rendered as path and the original textual info are lost. +Use the @option{-svgconvert} option to allow for rendering @LaTeX{} formulas. +Note that the glyph are rendered as path and the original textual info are +lost. + @item -Use one of the @option{-d*latex*} devices to produce a .tex file (plus support -.eps or .pdf files) to be further processed by an external LaTeX engine. -Note that the @code{print} function will first set the interpreter of all -strings to @qcode{"latex"}, which means all strings must be valid latex strings. -provided that all strings can be processed by LaTeX, not only those. +Use one of the @option{-d*latex*} devices to produce a .tex file (plus +supporting .eps or .pdf files) to be further processed by an external @LaTeX{} +engine. Note that the @code{print} function will first set the interpreter of +all strings to @qcode{"latex"}, which means all strings must be valid @LaTeX{} +strings. @end itemize A complete example showing the capabilities of text printing using the @@ -1904,7 +1909,8 @@ @cindex graphics colors @cindex colors, graphics -Colors may be specified in three ways: 1) RGB triplets, 2) by name, or 3) by HTML notation. +Colors may be specified in three ways: 1) RGB triplets, 2) by name, or 3) by +HTML notation. @table @asis
--- a/libinterp/corefcn/__isprimelarge__.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/__isprimelarge__.cc Wed Nov 24 20:26:59 2021 -0800 @@ -149,9 +149,9 @@ DEFUN (__isprimelarge__, args, , doc: /* -*- texinfo -*- -@deftypefn {} {@var{x} =} __isprimelarge__ (@var{n}) +@deftypefn {} {@var{x} =} __isprimelarge__ (@var{n}) Use the Miller-Rabin test to find out whether the elements of N are prime or -composite. The input N is required to be a vector or array of 64-bit integers. +composite. The input N is required to be a vector or array of 64-bit integers. You should call isprime(N) instead of directly calling this function. @seealso{isprime, factor}
--- a/libinterp/corefcn/defaults.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/defaults.cc Wed Nov 24 20:26:59 2021 -0800 @@ -508,7 +508,7 @@ DEFUN (user_config_dir, args, , doc: /* -*- texinfo -*- -@deftypefn {} {cfg_dir = } user_config_dir () +@deftypefn {} {cfg_dir =} user_config_dir () Return the (platform-specific) directory for user configuration. @seealso{user_data_dir} @end deftypefn */) @@ -526,7 +526,7 @@ DEFUN (user_data_dir, args, , doc: /* -*- texinfo -*- -@deftypefn {} {data_dir = } user_data_dir () +@deftypefn {} {data_dir =} user_data_dir () Return the (platform-specific) directory for user data. @seealso{user_config_dir} @end deftypefn */)
--- a/libinterp/corefcn/input.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/input.cc Wed Nov 24 20:26:59 2021 -0800 @@ -1577,7 +1577,7 @@ DEFMETHOD (dir_encoding, interp, args, nargout, doc: /* -*- texinfo -*- -@deftypefn {} {@var{current_encoding} =} dir_encoding (@var{dir}) +@deftypefn {} {@var{current_encoding} =} dir_encoding (@var{dir}) @deftypefnx {} {@var{prev_encoding} =} dir_encoding (@var{dir}, @var{encoding}) @deftypefnx {} {} dir_encoding (@dots{}) Set and query the @var{encoding} that is used for reading m-files in @var{dir}. @@ -1587,7 +1587,7 @@ The string @var{DIR} must match the form how the directory would appear in the load path. -The @var{encoding} must be a valid encoding identifier or @code{"delete"}. In +The @var{encoding} must be a valid encoding identifier or @qcode{"delete"}. In the latter case, the (globally set) m-file encoding will be used for the given @var{dir}. @@ -1598,7 +1598,7 @@ The directory encoding is automatically read from the file @file{.oct-config} when a new path is added to the load path (for example with @code{addpath}). To set the encoding for all files in the same folder, that file must contain -a line starting with @code{"encoding="} followed by the encoding identifier. +a line starting with @qcode{"encoding="} followed by the encoding identifier. For example to set the file encoding for all files in the same folder to ISO 8859-1 (Latin-1), create a file @file{.oct-config} with the following
--- a/libinterp/corefcn/jsondecode.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/jsondecode.cc Wed Nov 24 20:26:59 2021 -0800 @@ -501,9 +501,9 @@ @qcode{"Prefix"}, see @ref{XREFmatlab_lang_makeValidName,,matlab.lang.makeValidName}. -If the value of the option @qcode{\"makeValidName\"} is false then names +If the value of the option @qcode{"makeValidName"} is false then names will not be changed by @code{matlab.lang.makeValidName} and the -@qcode{\"ReplacementStyle\"} and @qcode{\"Prefix\"} options will be ignored. +@qcode{"ReplacementStyle"} and @qcode{"Prefix"} options will be ignored. NOTE: Decoding and encoding JSON text is not guaranteed to reproduce the original text as some names may be changed by @code{matlab.lang.makeValidName}.
--- a/libinterp/corefcn/oct-hist.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/oct-hist.cc Wed Nov 24 20:26:59 2021 -0800 @@ -821,7 +821,7 @@ The default value is @file{@w{@env{$DATA}}/octave/history}, where @w{@env{$DATA}} is the platform-specific location for (roaming) user data files -(e.g. @w{@env{$XDG_DATA_HOME}} or, if that is not set, @file{~/.local/share} on +(e.g., @w{@env{$XDG_DATA_HOME}} or, if that is not set, @file{~/.local/share} on Unix-like operating systems or @w{@env{%APPDATA%}} on Windows). The default value may be overridden by the environment variable @w{@env{OCTAVE_HISTFILE}}.
--- a/libinterp/corefcn/qr.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/corefcn/qr.cc Wed Nov 24 20:26:59 2021 -0800 @@ -231,11 +231,11 @@ @end example If the input matrix @var{A} is sparse, the sparse QR@tie{}factorization -is computed by using @sc{SPQR} or @sc{CXSparse} (e.g., if @sc{SPQR} is not +is computed by using @sc{SPQR} or @sc{cxsparse} (e.g., if @sc{SPQR} is not available). Because the matrix @var{Q} is, in general, a full matrix, it is recommended to request only one return value @var{R}. In that case, the -computation avoids the construction of @var{Q} and returns a sparse @var{R} such -that @code{@var{R} = chol (@var{A}' * @var{A})}. +computation avoids the construction of @var{Q} and returns a sparse @var{R} +such that @code{@var{R} = chol (@var{A}' * @var{A})}. If @var{A} is dense, an additional matrix @var{B} is supplied and two return values are requested, then @code{qr} returns @var{C}, where @@ -261,7 +261,7 @@ 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 -matrix. In this case, the defining relationship is: +matrix. In this case, the defining relationship is: @example @var{Q} * @var{R} = @var{A}(:, @var{P}) @@ -276,7 +276,7 @@ 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 @qcode{"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 +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
--- a/libinterp/octave-value/ov.cc Wed Nov 24 13:19:49 2021 -0500 +++ b/libinterp/octave-value/ov.cc Wed Nov 24 20:26:59 2021 -0800 @@ -3704,7 +3704,7 @@ diagonal matrices as full matrices. When called from inside a function with the @qcode{"local"} option, the setting -is changed locally for the function and any subroutines it calls. The original +is changed locally for the function and any subroutines it calls. The original setting is restored when exiting the function. @seealso{optimize_range, optimize_permutation_matrix} @end deftypefn */)
--- a/scripts/+containers/Map.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/+containers/Map.m Wed Nov 24 20:26:59 2021 -0800 @@ -31,15 +31,15 @@ ## @deftypefnx {} {@var{m} =} containers.Map (@var{keys}, @var{vals}, @qcode{"UniformValues"}, @var{is_uniform}) ## @deftypefnx {} {@var{m} =} containers.Map (@qcode{"KeyType"}, @var{kt}, @qcode{"ValueType"}, @var{vt}) ## - ## Create an object of the containers.Map class that stores a list of key/value - ## pairs. + ## Create an object of the containers.Map class that stores a list of + ## key/value pairs. ## ## @var{keys} is an array of @emph{unique} keys for the map. The keys can be ## numeric scalars or strings. The type for numeric keys may be one of ## @qcode{"double"}, @qcode{"single"}, @qcode{"int32"}, @qcode{"uint32"}, ## @qcode{"int64"}, or @qcode{"uint64"}. Other numeric or logical keys will - ## be converted to @qcode{"double"}. A single string key may be entered as is. - ## Multiple string keys are entered as a cell array of strings. + ## be converted to @qcode{"double"}. A single string key may be entered as + ## is. Multiple string keys are entered as a cell array of strings. ## ## @var{vals} is an array of values for the map with the @emph{same} number ## of elements as @var{keys}. @@ -48,18 +48,18 @@ ## as the key type and @qcode{"any"} as the value type. ## ## The @qcode{"UniformValues"} option specifies whether the values of - ## the map must be strictly of the same type. If @var{is_uniform} is true, any - ## values which would be added to the map are first validated to ensure they - ## are of the correct type. + ## the map must be strictly of the same type. If @var{is_uniform} is true, + ## any values which would be added to the map are first validated to ensure + ## they are of the correct type. ## - ## When called with @qcode{"KeyType"} and @qcode{"ValueType"} arguments, create - ## an empty map with the specified types. The inputs @var{kt} and @var{vt} are - ## the types for the keys and values of the map respectively. Allowed values - ## for @var{kt} are @qcode{"char"}, @qcode{"double"}, @qcode{"single"}, - ## @qcode{"int32"}, @qcode{"uint32"}, @qcode{"int64"}, @qcode{"uint64"}. - ## Allowed values for @var{vt} are @qcode{"any"}, @qcode{"char"}, - ## @qcode{"double"}, @qcode{"single"}, @qcode{"int32"}, @qcode{"uint32"}, - ## @qcode{"int64"}, @qcode{"uint64"}, @qcode{"logical"}. + ## When called with @qcode{"KeyType"} and @qcode{"ValueType"} arguments, + ## create an empty map with the specified types. The inputs @var{kt} and + ## @var{vt} are the types for the keys and values of the map respectively. + ## Allowed values for @var{kt} are @qcode{"char"}, @qcode{"double"}, + ## @qcode{"single"}, @qcode{"int32"}, @qcode{"uint32"}, @qcode{"int64"}, + ## @qcode{"uint64"}. Allowed values for @var{vt} are @qcode{"any"}, + ## @qcode{"char"}, @qcode{"double"}, @qcode{"single"}, @qcode{"int32"}, + ## @qcode{"uint32"}, @qcode{"int64"}, @qcode{"uint64"}, @qcode{"logical"}. ## ## The return value @var{m} is an object of the containers.Map class. ## @seealso{struct} @@ -71,7 +71,8 @@ ## @deftypefn {} {@var{type} =} Map.KeyType () ## Return the key type. ## - ## Possible values are listed above when describing input variable @var{kt}. + ## Possible values are listed above when describing input variable + ## @var{kt}. ## @end deftypefn KeyType = "char"; @@ -80,7 +81,8 @@ ## @deftypefn {} {@var{type} =} Map.ValueType () ## Return the value type. ## - ## Possible values are listed above when describing input variable @var{vt}. + ## Possible values are listed above when describing input variable + ## @var{vt}. ## @end deftypefn ValueType = "any"; @@ -274,11 +276,12 @@ ## -*- texinfo -*- ## @deftypefn {} {@var{mask} =} Map.isKey (@var{keySet}) - ## Return a logical array which is true where the elements of @var{keySet} are - ## keys of the map and false otherwise. + ## Return a logical array which is true where the elements of + ## @var{keySet} are keys of the map and false otherwise. ## - ## @var{keySet} is a cell array of keys. If a single key is being checked, it - ## can be entered directly as a scalar value or a char vector. + ## @var{keySet} is a cell array of keys. If a single key is being + ## checked, it can be entered directly as a scalar value or a char + ## vector. ## @end deftypefn if (! iscell (keySet)) @@ -330,10 +333,12 @@ ## @deftypefn {} {@var{l} =} Map.size (@var{n}) ## @deftypefnx {} {@var{sz} =} Map.size () ## @deftypefnx {} {@var{dim_1}, @dots{}, @var{dim_n} =} Map.size () - ## If @var{n} is 1, return the number of key/value pairs in the map, otherwise - ## return 1. - ## Without input arguments, return vector @code{[@var{l}, 1]} where @var{l} is - ## the number of key/value pairs in the map. + ## If @var{n} is 1, return the number of key/value pairs in the map, + ## otherwise return 1. + ## + ## Without input arguments, return vector @code{[@var{l}, 1]} where + ## @var{l} is the number of key/value pairs in the map. + ## ## With multiple outputs, return @code{[@var{l}, @dots{}, 1]}. ## @end deftypefn
--- a/scripts/+matlab/+net/base64decode.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/+matlab/+net/base64decode.m Wed Nov 24 20:26:59 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {@var{out_vec} =} matlab.net.base64decode (@var{b64_str}) +## @deftypefn {} {@var{out_vec} =} matlab.net.base64decode (@var{b64_str}) ## ## Convert base64 encoded @var{b64_str} to uint8 vector @var{out_vec}. ##
--- a/scripts/+matlab/+net/base64encode.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/+matlab/+net/base64encode.m Wed Nov 24 20:26:59 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {@var{b64_str} =} matlab.net.base64encode (@var{in}) +## @deftypefn {} {@var{b64_str} =} matlab.net.base64encode (@var{in}) ## ## Convert @var{in} to a base64 encoded string @var{b64_str}. ##
--- a/scripts/deprecated/disable_diagonal_matrix.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/deprecated/disable_diagonal_matrix.m Wed Nov 24 20:26:59 2021 -0800 @@ -29,10 +29,10 @@ ## @deftypefnx {} {} disable_diagonal_matrix (@var{new_val}, "local") ## Query or set whether storing diagonal matrices in a special space-efficient ## format is disabled. -## +## ## The default value is false. If this option is set to true, Octave will ## store ranges as full matrices. -## +## ## When called from inside a function with the @qcode{"local"} option, the ## setting is changed locally for the function and any subroutines it calls. ## The original setting is restored when exiting the function.
--- a/scripts/deprecated/disable_permutation_matrix.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/deprecated/disable_permutation_matrix.m Wed Nov 24 20:26:59 2021 -0800 @@ -29,10 +29,10 @@ ## @deftypefnx {} {} disable_permutation_matrix (@var{new_val}, "local") ## Query or set whether storing permutation matrices in a special ## space-efficient format is disabled. -## +## ## The default value is false. If this option is set to true, Octave will ## store ranges as full matrices. -## +## ## When called from inside a function with the @qcode{"local"} option, the ## setting is changed locally for the function and any subroutines it calls. ## The original setting is restored when exiting the function.
--- a/scripts/deprecated/disable_range.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/deprecated/disable_range.m Wed Nov 24 20:26:59 2021 -0800 @@ -29,10 +29,10 @@ ## @deftypefnx {} {} disable_range (@var{new_val}, "local") ## Query or set whether storing ranges in a special space-efficient format is ## disabled. -## +## ## The default value is false. If this option is set to true, Octave will ## store ranges as full matrices. -## +## ## When called from inside a function with the @qcode{"local"} option, the ## setting is changed locally for the function and any subroutines it calls. ## The original setting is restored when exiting the function.
--- a/scripts/help/warning_ids.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/help/warning_ids.m Wed Nov 24 20:26:59 2021 -0800 @@ -28,10 +28,10 @@ ## ## @table @code ## @item Octave:abbreviated-property-match -## If the @code{Octave:abbreviated-property-match} warning is enabled, a warning -## is printed if a non-exact or ambiguous match is being used for a operation -## specifying an object property. For example, for a graphics object, -## @var{fig}, with the property @qcode{'displayname'}, +## If the @code{Octave:abbreviated-property-match} warning is enabled, a +## warning is printed if a non-exact or ambiguous match is being used for a +## operation specifying an object property. For example, for a graphics +## object, @var{fig}, with the property @qcode{'displayname'}, ## @code{get (@var{fig}, 'dis')} elicits a warning if the ## @code{Octave:abbreviated-property-match} warning is enabled. ## By default, the @code{Octave:abbreviated-property-match} warning is enabled.
--- a/scripts/image/colormap.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/image/colormap.m Wed Nov 24 20:26:59 2021 -0800 @@ -85,7 +85,8 @@ ## @item white @tab all white colormap (no colors). ## @end multitable ## @seealso{viridis, turbo, jet, cubehelix, hsv, rainbow, hot, cool, spring, -## summer, autumn, winter, gray, bone, copper, pink, ocean, colorcube, flag, lines, prism, white} +## summer, autumn, winter, gray, bone, copper, pink, ocean, colorcube, flag, +## lines, prism, white} ## @end deftypefn function cmap = colormap (varargin)
--- a/scripts/miscellaneous/inputParser.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/miscellaneous/inputParser.m Wed Nov 24 20:26:59 2021 -0800 @@ -45,44 +45,46 @@ ## After defining the function API with these methods, the supplied arguments ## can be parsed with the @code{parse} method and the parsing results ## accessed with the @code{Results} accessor. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.Parameters ## Return list of parameter names already defined. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.Results - ## Return structure with argument names as fieldnames and corresponding values. + ## Return structure with argument names as fieldnames and corresponding + ## values. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.Unmatched ## Return structure similar to @code{Results}, but for unmatched parameters. ## See the @code{KeepUnmatched} property. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.UsingDefaults - ## Return cell array with the names of arguments that are using default values. + ## Return cell array with the names of arguments that are using default + ## values. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.CaseSensitive = @var{boolean} ## Set whether matching of argument names should be case sensitive. Defaults ## to false. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.FunctionName = @var{name} ## Set function name to be used in error messages; Defaults to empty string. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.KeepUnmatched = @var{boolean} - ## Set whether an error should be given for non-defined arguments. Defaults to - ## false. If set to true, the extra arguments can be accessed through + ## Set whether an error should be given for non-defined arguments. Defaults + ## to false. If set to true, the extra arguments can be accessed through ## @code{Unmatched} after the @code{parse} method. Note that since ## @code{Switch} and @code{Parameter} arguments can be mixed, it is ## not possible to know the unmatched type. If argument is found unmatched ## it is assumed to be of the @code{Parameter} type and it is expected to ## be followed by a value. + ## @end deftypefn ## - ## @end deftypefn ## @deftypefn {} {} inputParser.StructExpand = @var{boolean} ## Set whether a structure can be passed to the function instead of ## parameter/value pairs. Defaults to true. @@ -206,23 +208,22 @@ ## -*- texinfo -*- ## @deftypefn {} {} addRequired (@var{argname}) ## @deftypefnx {} {} addRequired (@var{argname}, @var{validator}) - ## Add new mandatory argument to the object @var{parser} of inputParser class. - ## - ## This method belongs to the inputParser class and implements an ordered - ## arguments type of API. + ## Add new mandatory argument to the object @var{parser} of inputParser + ## class. This method belongs to the inputParser class and implements + ## an ordered arguments type of API. ## - ## @var{argname} must be a string with the name of the new argument. The order - ## in which new arguments are added with @code{addrequired}, represents the - ## expected order of arguments. + ## @var{argname} must be a string with the name of the new argument. The + ## order in which new arguments are added with @code{addrequired}, + ## represents the expected order of arguments. ## - ## @var{validator} is an optional function handle to validate the given values - ## for the argument with name @var{argname}. Alternatively, a function name - ## can be used. + ## @var{validator} is an optional function handle to validate the given + ## values for the argument with name @var{argname}. Alternatively, a + ## function name can be used. ## ## See @code{help inputParser} for examples. ## - ## @emph{Note}: this can be used together with the other type of arguments but - ## it must be the first (see @code{@@inputParser}). + ## @emph{Note}: this can be used together with the other type of + ## arguments but it must be the first (see @code{@@inputParser}). ## ## @end deftypefn @@ -245,23 +246,25 @@ ## Add new optional argument to the object @var{parser} of the class ## inputParser to implement an ordered arguments type of API ## - ## @var{argname} must be a string with the name of the new argument. The order - ## in which new arguments are added with @code{addOptional}, represents the - ## expected order of arguments. + ## @var{argname} must be a string with the name of the new argument. The + ## order in which new arguments are added with @code{addOptional}, + ## represents the expected order of arguments. ## - ## @var{default} will be the value used when the argument is not specified. + ## @var{default} will be the value used when the argument is not + ## specified. ## - ## @var{validator} is an optional anonymous function to validate the given - ## values for the argument with name @var{argname}. Alternatively, a - ## function name can be used. + ## @var{validator} is an optional anonymous function to validate the + ## given values for the argument with name @var{argname}. Alternatively, + ## a function name can be used. ## ## See @code{help inputParser} for examples. ## - ## @emph{Note}: if a string argument does not validate, it will be considered a - ## ParamValue key. If an optional argument is not given a validator, anything - ## will be valid, and so any string will be considered will be the value of the - ## optional argument (in @sc{matlab}, if no validator is given and argument is - ## a string it will also be considered a ParamValue key). + ## @emph{Note}: if a string argument does not validate, it will be + ## considered a ParamValue key. If an optional argument is not given a + ## validator, anything will be valid, and so any string will be + ## considered will be the value of the optional argument (in @sc{matlab}, + ## if no validator is given and argument is a string it will also be + ## considered a ParamValue key). ## ## @end deftypefn @@ -280,8 +283,8 @@ ## -*- texinfo -*- ## @deftypefn {} {} addParamValue (@var{argname}, @var{default}) ## @deftypefnx {} {} addParamValue (@var{argname}, @var{default}, @var{validator}) - ## Add new parameter to the object @var{parser} of the class inputParser to - ## implement a name/value pair type of API. + ## Add new parameter to the object @var{parser} of the class inputParser + ## to implement a name/value pair type of API. ## ## This is an alias for @code{addParameter} method without the ## @qcode{"PartialMatchPriority"} option. See it for the help text. @@ -299,16 +302,17 @@ ## -*- texinfo -*- ## @deftypefn {} {} addParameter (@var{argname}, @var{default}) ## @deftypefnx {} {} addParameter (@var{argname}, @var{default}, @var{validator}) - ## Add new parameter to the object @var{parser} of the class inputParser to - ## implement a name/value pair type of API. + ## Add new parameter to the object @var{parser} of the class inputParser + ## to implement a name/value pair type of API. ## ## @var{argname} must be a string with the name of the new parameter. ## - ## @var{default} will be the value used when the parameter is not specified. + ## @var{default} will be the value used when the parameter is not + ## specified. ## - ## @var{validator} is an optional function handle to validate the given values - ## for the parameter with name @var{argname}. Alternatively, a function name - ## can be used. + ## @var{validator} is an optional function handle to validate the given + ## values for the parameter with name @var{argname}. Alternatively, a + ## function name can be used. ## ## See @code{help inputParser} for examples. ## @@ -347,18 +351,18 @@ ## -*- texinfo -*- ## @deftypefn {} {} addSwitch (@var{argname}) - ## Add new switch type of argument to the object @var{parser} of inputParser - ## class. + ## Add new switch type of argument to the object @var{parser} of + ## inputParser class. ## ## This method belongs to the inputParser class and implements a switch ## arguments type of API. ## - ## @var{argname} must be a string with the name of the new argument. Arguments - ## of this type can be specified at the end, after @code{Required} and - ## @code{Optional}, and mixed between the @code{Parameter}. They default to - ## false. If one of the arguments supplied is a string like @var{argname}, - ## then after parsing the value of @var{parse}.Results.@var{argname} will be - ## true. + ## @var{argname} must be a string with the name of the new argument. + ## Arguments of this type can be specified at the end, after + ## @code{Required} and @code{Optional}, and mixed between the + ## @code{Parameter}. They default to false. If one of the arguments + ## supplied is a string like @var{argname}, then after parsing the value + ## of @var{parse}.Results.@var{argname} will be true. ## ## See @code{help inputParser} for examples. ## @@ -375,11 +379,12 @@ ## -*- texinfo -*- ## @deftypefn {} {} parse (@var{varargin}) - ## Parses and validates list of arguments according to object @var{parser} of - ## the class inputParser. + ## Parses and validates list of arguments according to object + ## @var{parser} of the class inputParser. ## ## After parsing, the results can be accessed with the @code{Results} - ## accessor. See @code{help inputParser} for a more complete description. + ## accessor. See @code{help inputParser} for a more complete + ## description. ## ## @end deftypefn
--- a/scripts/miscellaneous/jupyter_notebook.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/miscellaneous/jupyter_notebook.m Wed Nov 24 20:26:59 2021 -0800 @@ -21,8 +21,8 @@ ## @deftypefn {} {@var{notebook} =} jupyter_notebook (@var{notebook_file_name}) ## @deftypefnx {} {@var{notebook} =} jupyter_notebook (@var{notebook_file_name}, @var{options}) ## - ## Run and fill the Jupyter Notebook in @var{notebook_file_name} within - ## GNU Octave. + ## Run and fill the Jupyter Notebook in @var{notebook_file_name} within GNU + ## Octave. ## ## Supported are textual and graphical Octave outputs. ## @@ -30,8 +30,8 @@ ## representing the JSON-decoded Jupyter Notebook. This attribute is ## intentionally public to enable advanced notebook manipulations. ## - ## Note: Jupyter Notebook versions (@qcode{nbformat}) lower than 4.0 are - ## not supported. + ## Note: Jupyter Notebook versions (@qcode{nbformat}) lower than 4.0 are not + ## supported. ## ## The second argument @var{options} is a struct with fields: ## @itemize @bullet @@ -50,9 +50,9 @@ ## PNG (default) ## ## @item - ## SVG (Note: If SVG images do not appear in the notebook, it is most - ## related to the Jupyter Notebook security mechanism and explicitly - ## "trusting" them is necessary). + ## SVG (Note: If SVG images do not appear in the notebook, it is most related + ## to the Jupyter Notebook security mechanism and explicitly "trusting" them + ## is necessary). ## ## @item ## JPG @@ -78,22 +78,22 @@ ## ## Run all cells and generate the filled notebook ## ## ## Instantiate an object from the notebook file - ## notebook = jupyter_notebook("myNotebook.ipynb") + ## notebook = jupyter_notebook ("myNotebook.ipynb") ## @result{} notebook = ## ## <object jupyter_notebook> ## ## ## Run the code and embed the results in the @qcode{notebook} attribute - ## notebook.run_all() + ## notebook.run_all () ## ## Generate the new notebook by overwriting the original notebook - ## notebook.generate_notebook("myNotebook.ipynb") + ## notebook.generate_notebook ("myNotebook.ipynb") ## @end group ## ## @group ## ## Run the second cell and generate the filled notebook ## ## ## Instantiate an object from the notebook file - ## notebook = jupyter_notebook("myNotebook.ipynb") + ## notebook = jupyter_notebook ("myNotebook.ipynb") ## @result{} notebook = ## ## <object jupyter_notebook> @@ -101,20 +101,20 @@ ## ## Run the code and embed the results in the @qcode{notebook} attribute ## notebook.run(2) ## ## Generate the new notebook in a new file - ## notebook.generate_notebook("myNewNotebook.ipynb") + ## notebook.generate_notebook ("myNewNotebook.ipynb") ## @end group ## ## @group ## ## Generate an Octave script from a notebook ## ## ## Instantiate an object from the notebook file - ## notebook = jupyter_notebook("myNotebook.ipynb") + ## notebook = jupyter_notebook ("myNotebook.ipynb") ## @result{} notebook = ## ## <object jupyter_notebook> ## ## ## Generate the octave script - ## notebook.generate_octave_script("myScript.m") + ## notebook.generate_octave_script ("myScript.m") ## @end group ## @end example ## @@ -228,7 +228,7 @@ ## Write an Octave script that has the contents of the Jupyter Notebook ## stored in the @qcode{notebook} attribute to @var{script_file_name}. ## - ## Non code cells are generated as block comments. + ## Non-code cells are generated as block comments. ## ## See @code{help jupyter_notebook} for examples. ## @@ -306,7 +306,7 @@ ## The first Jupyter Notebook cell has the index 1. ## ## Note: The code evaluation of the Jupyter Notebook cells is done - ## in a separate Jupyter Notebook context. Thus currently open + ## in a separate Jupyter Notebook context. Thus, currently open ## figures and workspace variables won't be affected by executing ## this function. However, current workspace variables cannot be ## accessed either. @@ -462,7 +462,7 @@ ## output cells in the object. ## ## Note: The code evaluation of the Jupyter Notebook cells is done - ## in a separate Jupyter Notebook context. Thus currently open + ## in a separate Jupyter Notebook context. Thus, currently open ## figures and workspace variables won't be affected by executing ## this function. However, current workspace variables cannot be ## accessed either.
--- a/scripts/plot/draw/stem3.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/plot/draw/stem3.m Wed Nov 24 20:26:59 2021 -0800 @@ -50,7 +50,7 @@ ## ## The optional return value @var{h} is a handle to the @nospell{"stem series"} ## hggroup containing the line and marker objects used for the plot. -## @xref{XREFstem}, for a description of the @nospell{"stem series"} +## @xref{XREFstem,,stem}, for a description of the @nospell{"stem series"} ## object. ## ## Example:
--- a/scripts/plot/util/print.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/plot/util/print.m Wed Nov 24 20:26:59 2021 -0800 @@ -137,8 +137,8 @@ ## formats. ## ## Strings using the @qcode{"latex"} interpreter, are rendered using path -## objects. This looks good but note that textual info (font, characters@dots{}) -## are lost. +## objects. This looks good but note that textual info (font, +## characters@dots{}) are lost. ## ## @item Output Simplification: ## By default, the option @option{-painters} renders patch and surface objects
--- a/scripts/sparse/eigs.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/sparse/eigs.m Wed Nov 24 20:26:59 2021 -0800 @@ -204,7 +204,7 @@ ## Programming Notes: For small problems, @var{n} < 500, consider using ## @code{eig (full (@var{A}))}. ## -## If ARPACK fails to converge consider increasing the number of Lanczos +## If @sc{arpack} fails to converge consider increasing the number of Lanczos ## vectors (@var{opt}.p), increasing the number of iterations ## (@var{opt}.maxiter), or decreasing the tolerance (@var{opt}.tol). ##
--- a/scripts/statistics/iqr.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/statistics/iqr.m Wed Nov 24 20:26:59 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {@var{Z} =} iqr (@var{x}) +## @deftypefn {} {@var{Z} =} iqr (@var{x}) ## @deftypefnx {} {@var{Z} =} iqr (@var{x}, @var{dim}) ## @deftypefnx {} {@var{Z} =} iqr (@var{x}, @qcode{"ALL"}) ## Return the interquartile range of @var{x}, defined as the distance between @@ -45,7 +45,7 @@ ## The optional variable @var{dim} can be used to force @code{iqr} to operate ## over the specified dimension. @var{dim} can either be a scalar dimension or ## a vector of non-repeating dimensions over which to operate. In either case -## @var{dim} must be positive integers. A vector @var{dim} concatenates all +## @var{dim} must be positive integers. A vector @var{dim} concatenates all ## specified diminsions for independent operation by @code{iqr}. ## ## Specifying dimension @qcode{"ALL"} will force @code{iqr} to operate
--- a/scripts/strings/validatestring.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/strings/validatestring.m Wed Nov 24 20:26:59 2021 -0800 @@ -35,11 +35,12 @@ ## cell array of strings of valid values, then @var{validstr} will be the ## validated form of @var{str} where validation is defined as @var{str} being ## a member or substring of @var{validstr}. This is useful for both verifying -## and expanding short options, such as @qcode{"r"}, to their longer forms, such -## as @qcode{"red"}. If @var{str} is a substring of @var{validstr}, and there -## are multiple matches, the shortest match will be returned if all matches are -## substrings of each other. Otherwise, an error will be raised because the -## expansion of @var{str} is ambiguous. All comparisons are case insensitive. +## and expanding short options, such as @qcode{"r"}, to their longer forms, +## such as @qcode{"red"}. If @var{str} is a substring of @var{validstr}, +## and there are multiple matches, the shortest match will be returned if +## all matches are substrings of each other. Otherwise, an error will be +## raised because the expansion of @var{str} is ambiguous. All comparisons +## are case insensitive. ## ## The additional inputs @var{funcname}, @var{varname}, and @var{position} ## are optional and will make any generated validation error message more
--- a/scripts/web/weboptions.m Wed Nov 24 13:19:49 2021 -0500 +++ b/scripts/web/weboptions.m Wed Nov 24 20:26:59 2021 -0800 @@ -31,10 +31,10 @@ ## ## Specify parameters for RESTful web services. ## - ## @code{weboptions} with no inputs returns a default @code{weboptions} object - ## to specify parameters for a request to a web service. A @code{weboptions} - ## object can be an optional input argument to the @code{webread} and - ## @code{webwrite} functions. + ## @code{weboptions} with no inputs returns a default @code{weboptions} + ## object to specify parameters for a request to a web service. A + ## @code{weboptions} object can be an optional input argument to the + ## @code{webread} and @code{webwrite} functions. ## ## Multiple name and value pair arguments may be specified in any order as ## @var{name1}, @var{value1}, @var{name2}, @var{value2}, etc. @@ -58,7 +58,8 @@ ## current version of Octave as returned by @code{version}. ## ## @item - ## @samp{Timeout} --- Specify the timeout value for the connection in seconds. + ## @samp{Timeout} --- Specify the timeout value for the connection in + ## seconds. ## ## Default is 10 seconds. @samp{Inf} is not currently supported. ##