Mercurial > octave
changeset 25579:07c2c42f457e stable
doc: Miscellaneous documentation fixes all over the manual (bug #54288).
* embedded.cc, defaults.cc, error.cc, hex2num.cc, load-save.cc, integral2.m,
integral3.m, quad2d.m, warning_ids.m, decic.m, lsqnonneg.m, pqpnonneg.m,
bicg.m, betaincinv.m: Removal of duplicate words and redundant ')' and ';'
characters. Added missing '"', ')' characters. Renamed variables to match
other occurrences in docstring. Use '*' instead of 'x' for multiply.
Surround variables with @var{}.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 11 Jul 2018 08:40:07 -0700 |
parents | 32ddc111ff49 |
children | c71d13bf2b63 9f422e49be15 |
files | examples/code/embedded.cc libinterp/corefcn/defaults.cc libinterp/corefcn/error.cc libinterp/corefcn/hex2num.cc libinterp/corefcn/load-save.cc scripts/general/integral2.m scripts/general/integral3.m scripts/general/quad2d.m scripts/help/warning_ids.m scripts/ode/decic.m scripts/optimization/lsqnonneg.m scripts/optimization/pqpnonneg.m scripts/sparse/bicg.m scripts/specfun/betaincinv.m |
diffstat | 14 files changed, 17 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/examples/code/embedded.cc Tue Jul 10 20:57:59 2018 -0700 +++ b/examples/code/embedded.cc Wed Jul 11 08:40:07 2018 -0700 @@ -33,7 +33,7 @@ // exit (status); // } // - // You may skip this step if you don't need to do do anything + // You may skip this step if you don't need to do anything // between reading the startup files and telling the interpreter // that you are ready to execute commands.
--- a/libinterp/corefcn/defaults.cc Tue Jul 10 20:57:59 2018 -0700 +++ b/libinterp/corefcn/defaults.cc Wed Jul 11 08:40:07 2018 -0700 @@ -339,7 +339,7 @@ DEFUN (OCTAVE_EXEC_HOME, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} OCTAVE_HOME () +@deftypefn {} {} OCTAVE_EXEC_HOME () Return the name of the top-level Octave installation directory for architecture-dependent files. If not specified separately, the value is the same as OCTAVE_HOME@. OCTAVE_EXEC_HOME corresponds to the
--- a/libinterp/corefcn/error.cc Tue Jul 10 20:57:59 2018 -0700 +++ b/libinterp/corefcn/error.cc Wed Jul 11 08:40:07 2018 -0700 @@ -1438,7 +1438,7 @@ @deftypefnx {} {} warning (@var{warning_struct}) @deftypefnx {} {@var{warning_struct} =} warning (@dots{}) @deftypefnx {} {@var{mode_struct} =} warning (@var{state}, @var{mode}) -@deftypefnx {} {} warning (@var{mode_st}) +@deftypefnx {} {} warning (@var{mode_struct}) Display a warning message or control the behavior of Octave's warning system.
--- a/libinterp/corefcn/hex2num.cc Tue Jul 10 20:57:59 2018 -0700 +++ b/libinterp/corefcn/hex2num.cc Wed Jul 11 08:40:07 2018 -0700 @@ -294,7 +294,7 @@ @end group @end example -With the optional second argument @qcode{"cell}, return a cell array of +With the optional second argument @qcode{"cell"}, return a cell array of strings instead of a character array. @seealso{hex2num, hex2dec, dec2hex} @end deftypefn */)
--- a/libinterp/corefcn/load-save.cc Tue Jul 10 20:57:59 2018 -0700 +++ b/libinterp/corefcn/load-save.cc Wed Jul 11 08:40:07 2018 -0700 @@ -1799,8 +1799,8 @@ that Octave will save when writing a crash dump file. The limit is measured in kilobytes and is applied to the top-level workspace. -The name of the crash dump file is is specified by -@var{octave_core_file_name}). +The name of the crash dump file is specified by +@var{octave_core_file_name}. If @var{octave_core_file_options} flags specify a binary format, then @var{octave_core_file_limit} will be approximately the maximum size of the
--- a/scripts/general/integral2.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/general/integral2.m Wed Jul 11 08:40:07 2018 -0700 @@ -88,7 +88,7 @@ ## @end example ## ## The result is a volume, which for this constant-value integrand, is just -## @code{@var{Length} * @var{Width} x @var{Height}}. +## @code{@var{Length} * @var{Width} * @var{Height}}. ## ## Example 2 : integrate a triangular region in x-y plane ##
--- a/scripts/general/integral3.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/general/integral3.m Wed Jul 11 08:40:07 2018 -0700 @@ -89,7 +89,7 @@ ## @end example ## ## For this constant-value integrand, the result is a volume which is just -## @code{@var{Length} * @var{Width} x @var{Height}}. +## @code{@var{Length} * @var{Width} * @var{Height}}. ## ## Example 2 : integrate over a spherical volume ##
--- a/scripts/general/quad2d.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/general/quad2d.m Wed Jul 11 08:40:07 2018 -0700 @@ -93,7 +93,7 @@ ## @end example ## ## The result is a volume, which for this constant-value integrand, is just -## @code{@var{Length} * @var{Width} x @var{Height}}. +## @code{@var{Length} * @var{Width} * @var{Height}}. ## ## Example 2 : integrate a triangular region in x-y plane ##
--- a/scripts/help/warning_ids.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/help/warning_ids.m Wed Jul 11 08:40:07 2018 -0700 @@ -174,8 +174,7 @@ ## If the @code{Octave:erase:chararray} warning is enabled then the erase ## function will issue a warning if the input pattern is a character array ## rather than a string or cell array of strings. -## By default, the @code{Octave:eigs:UnconvergedEigenvalues} warning is -## enabled. +## By default, the @code{Octave:erase:chararray} warning is enabled. ## ## @item Octave:data-file-in-path ## If the @code{Octave:data-file-in-path} warning is enabled, a warning is
--- a/scripts/ode/decic.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/ode/decic.m Wed Jul 11 08:40:07 2018 -0700 @@ -61,9 +61,9 @@ ## compute the initial conditions. ## ## The function typically returns two outputs. Variable @var{y0_new} is a -## column vector and contains the consistent initial value of y. The output -## @var{yp0_new} is a column vector and contains the consistent initial value -## of yp. +## column vector and contains the consistent initial value of @var{y}. The +## output @var{yp0_new} is a column vector and contains the consistent initial +## value of @var{yp}. ## ## The optional third output @var{resnorm} is the norm of the vector of ## residuals. If @var{resnorm} is small, @code{decic} has successfully
--- a/scripts/optimization/lsqnonneg.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/optimization/lsqnonneg.m Wed Jul 11 08:40:07 2018 -0700 @@ -36,7 +36,7 @@ ## @var{x0} is an optional initial guess for the solution @var{x}. ## ## @var{options} is an options structure to change the behavior of the -## algorithm (@pxref{XREFoptimset,,optimset}. @code{lsqnonneg} recognizes +## algorithm (@pxref{XREFoptimset,,optimset}). @code{lsqnonneg} recognizes ## these options: @qcode{"MaxIter"}, @qcode{"TolX"}. ## ## Outputs:
--- a/scripts/optimization/pqpnonneg.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/optimization/pqpnonneg.m Wed Jul 11 08:40:07 2018 -0700 @@ -36,7 +36,7 @@ ## @var{x0} is an optional initial guess for the solution @var{x}. ## ## @var{options} is an options structure to change the behavior of the -## algorithm (@pxref{XREFoptimset,,optimset}. @code{pqpnonneg} recognizes +## algorithm (@pxref{XREFoptimset,,optimset}). @code{pqpnonneg} recognizes ## one option: @qcode{"MaxIter"}. ## ## Outputs:
--- a/scripts/sparse/bicg.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/sparse/bicg.m Wed Jul 11 08:40:07 2018 -0700 @@ -142,7 +142,7 @@ ## M1fun = @@(x, string) strcmp (string, "notransp") * (M1 \ x) + ... ## strcmp (string, "transp") * (M1' \ x); ## M2fun = @@(x, string) strcmp (string, "notransp") * (M2 \ x) + ... -## strcmp (string, "transp") * (M2' \ x);; +## strcmp (string, "transp") * (M2' \ x); ## @end group ## @end example ##
--- a/scripts/specfun/betaincinv.m Tue Jul 10 20:57:59 2018 -0700 +++ b/scripts/specfun/betaincinv.m Wed Jul 11 08:40:07 2018 -0700 @@ -55,7 +55,7 @@ ## The variable @var{y} must be in the interval [0,1], while @var{a} and ## @var{b} must be real and strictly positive. ## -## By default, @var{tail} is @qcode{"lower")} and the inverse of the incomplete +## By default, @var{tail} is @qcode{"lower"} and the inverse of the incomplete ## beta function integrated from 0 to @var{x} is computed. If @var{tail} is ## @qcode{"upper"} then the complementary function integrated from @var{x} to 1 ## is inverted.