Mercurial > octave
changeset 25472:9771111f04f4 stable
doc: Use @var rather than @code to mark inputs to functions in docstrings.
* graphics.cc (Fwaitfor), sparse.cc (Fsparse), toplev.cc (Fsystem),
colamd.cc (Fsymamd), cmpermute.m, imformats.m, krylov.m, run.m, stem.m,
stem3.m, stft.m, pcr.m, legendre.m, datestr.m:
Use @var rather than @code to mark inputs to functions in docstrings.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 13 Jun 2018 16:21:58 -0700 |
parents | e0906c38f18e |
children | 6a9ba6644272 a06983fe83a5 |
files | libinterp/corefcn/graphics.cc libinterp/corefcn/sparse.cc libinterp/corefcn/toplev.cc libinterp/dldfcn/colamd.cc scripts/image/cmpermute.m scripts/image/imformats.m scripts/linear-algebra/krylov.m scripts/miscellaneous/run.m scripts/plot/draw/stem.m scripts/plot/draw/stem3.m scripts/signal/stft.m scripts/sparse/pcr.m scripts/specfun/legendre.m scripts/time/datestr.m |
diffstat | 14 files changed, 17 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/graphics.cc Wed Jun 13 14:20:48 2018 -0700 +++ b/libinterp/corefcn/graphics.cc Wed Jun 13 16:21:58 2018 -0700 @@ -12163,14 +12163,14 @@ handle is invalid, the property does not exist or the property is already set to @var{value}, the function returns immediately. -An optional timeout can be specified using the property @code{timeout}. +An optional timeout can be specified using the property @qcode{"timeout"}. This timeout value is the number of seconds to wait for the condition to be true. @var{timeout} must be at least 1. If a smaller value is specified, a warning is issued and a value of 1 is used instead. If the timeout value is not an integer, it is truncated towards 0. -To define a condition on a property named @code{timeout}, use the string -@code{\timeout} instead. +To define a condition on a property named @qcode{"timeout"}, use the string +@qcode{'\timeout'} instead. In all cases, typing CTRL-C stops program execution immediately. @seealso{waitforbuttonpress, isequal}
--- a/libinterp/corefcn/sparse.cc Wed Jun 13 14:20:48 2018 -0700 +++ b/libinterp/corefcn/sparse.cc Wed Jun 13 16:21:58 2018 -0700 @@ -89,7 +89,7 @@ @code{sparse (@var{m}, @var{n})} will create an empty @var{m}x@var{n} sparse matrix and is equivalent to @code{sparse ([], [], [], @var{m}, @var{n})} -The argument @code{nzmax} is ignored but accepted for compatibility with +The argument @var{nzmax} is ignored but accepted for compatibility with @sc{matlab}. Example 1 (sum at repeated indices):
--- a/libinterp/corefcn/toplev.cc Wed Jun 13 14:20:48 2018 -0700 +++ b/libinterp/corefcn/toplev.cc Wed Jun 13 16:21:58 2018 -0700 @@ -222,8 +222,8 @@ @end example @noindent -will set the variable @code{output} to the string @samp{foo}, and the -variable @code{status} to the integer @samp{2}. +will set the variable @var{output} to the string @samp{foo}, and the +variable @var{status} to the integer @samp{2}. For commands run asynchronously, @var{status} is the process id of the command shell that is started to run the command.
--- a/libinterp/dldfcn/colamd.cc Wed Jun 13 14:20:48 2018 -0700 +++ b/libinterp/dldfcn/colamd.cc Wed Jun 13 16:21:58 2018 -0700 @@ -466,7 +466,7 @@ @code{max (16,@var{knobs}(1)*sqrt(n))} entries are removed prior to ordering, and ordered last in the output permutation @var{p}. No rows/columns are removed if @code{@var{knobs}(1) < 0}. If -@code{@var{knobs} (2)} is nonzero, @code{stats} and @var{knobs} are +@code{@var{knobs}(2)} is nonzero, @var{stats} and @var{knobs} are printed. The default is @code{@var{knobs} = [10 0]}. Note that @var{knobs} differs from earlier versions of @code{symamd}.
--- a/scripts/image/cmpermute.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/image/cmpermute.m Wed Jun 13 16:21:58 2018 -0700 @@ -30,7 +30,7 @@ ## When called with an optional third argument the order of colors in the new ## colormap is defined by @var{index}. ## -## @strong{Caution:} @code{index} should not have repeated elements or the +## @strong{Caution:} @var{index} should not have repeated elements or the ## function will fail. ## ## @end deftypefn
--- a/scripts/image/imformats.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/image/imformats.m Wed Jun 13 16:21:58 2018 -0700 @@ -28,7 +28,7 @@ ## ## @var{formats} is a structure with information about each supported file ## format, or from a specific format @var{ext}, the value displayed on the -## field @code{ext}. It contains the following fields: +## field @var{ext}. It contains the following fields: ## ## @table @asis ## @item ext
--- a/scripts/linear-algebra/krylov.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/linear-algebra/krylov.m Wed Jun 13 16:21:58 2018 -0700 @@ -33,7 +33,7 @@ ## If @var{V} is a vector, then @var{h} contains the Hessenberg matrix ## such that @nospell{@tcode{a*u == u*h+rk*ek'}}, in which ## @code{rk = a*u(:,k)-u*h(:,k)}, and @nospell{@tcode{ek'}} is the vector -## @code{[0, 0, @dots{}, 1]} of length @code{k}. Otherwise, @var{h} is +## @code{[0, 0, @dots{}, 1]} of length @var{k}. Otherwise, @var{h} is ## meaningless. ## ## If @var{V} is a vector and @var{k} is greater than @code{length (A) - 1},
--- a/scripts/miscellaneous/run.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/miscellaneous/run.m Wed Jun 13 16:21:58 2018 -0700 @@ -33,7 +33,7 @@ ## Implementation Note: If @var{script} includes a path component, then ## @code{run} first changes the working directory to the directory where ## @var{script} is found. Next, the script is executed. Finally, @code{run} -## returns to the original working directory unless @code{script} has +## returns to the original working directory unless @var{script} has ## specifically changed directories. ## @seealso{path, addpath, source} ## @end deftypefn
--- a/scripts/plot/draw/stem.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/plot/draw/stem.m Wed Jun 13 16:21:58 2018 -0700 @@ -36,7 +36,7 @@ ## ## The default color is @qcode{"b"} (blue), the default line style is ## @qcode{"-"}, and the default marker is @qcode{"o"}. The line style can -## be altered by the @code{linespec} argument in the same manner as the +## be altered by the @var{linespec} argument in the same manner as the ## @code{plot} command. If the @qcode{"filled"} argument is present the ## markers at the top of the stems will be filled in. For example, ##
--- a/scripts/plot/draw/stem3.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/plot/draw/stem3.m Wed Jun 13 16:21:58 2018 -0700 @@ -30,7 +30,7 @@ ## the default line style is @qcode{"-"}, and the default marker is ## @qcode{"o"}. ## -## The line style can be altered by the @code{linespec} argument in the same +## The line style can be altered by the @var{linespec} argument in the same ## manner as the @code{plot} command. If the @qcode{"filled"} argument is ## present the markers at the top of the stems will be filled in. ##
--- a/scripts/signal/stft.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/signal/stft.m Wed Jun 13 16:21:58 2018 -0700 @@ -50,7 +50,7 @@ ## @code{@var{y} = stft (@var{x}, @dots{})} returns the absolute values of the ## Fourier coefficients according to the @var{num_coef} positive frequencies. ## -## @code{[@var{y}, @var{c}] = stft (@code{x}, @dots{})} returns the entire +## @code{[@var{y}, @var{c}] = stft (@var{x}, @dots{})} returns the entire ## STFT-matrix @var{y} and a 3-element vector @var{c} containing the window ## size, increment, and window type, which is needed by the @code{synthesis} ## function.
--- a/scripts/sparse/pcr.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/sparse/pcr.m Wed Jun 13 16:21:58 2018 -0700 @@ -47,7 +47,7 @@ ## ## @item ## @var{maxit} is the maximum allowable number of iterations; if @code{[]} is -## supplied for @code{maxit}, or @code{pcr} has less arguments, a default +## supplied for @var{maxit}, or @code{pcr} has less arguments, a default ## value equal to 20 is used. ## ## @item
--- a/scripts/specfun/legendre.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/specfun/legendre.m Wed Jun 13 16:21:58 2018 -0700 @@ -89,7 +89,7 @@ ## @end group ## @end example ## -## When the optional argument @code{normalization} is @qcode{"sch"}, compute +## When the optional argument @var{normalization} is @qcode{"sch"}, compute ## the Schmidt semi-normalized associated Legendre function. The Schmidt ## semi-normalized associated Legendre function is related to the unnormalized ## Legendre functions by the following:
--- a/scripts/time/datestr.m Wed Jun 13 14:20:48 2018 -0700 +++ b/scripts/time/datestr.m Wed Jun 13 16:21:58 2018 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {} {@var{str} =} datestr (@var{date}) ## @deftypefnx {} {@var{str} =} datestr (@var{date}, @var{f}) ## @deftypefnx {} {@var{str} =} datestr (@var{date}, @var{f}, @var{p}) -## Format the given date/time according to the format @code{f} and return +## Format the given date/time according to the format @var{f} and return ## the result in @var{str}. ## ## @var{date} is a serial date number (see @code{datenum}) or a date vector