Mercurial > octave
diff scripts/image/iscolormap.m @ 30558:83aeaba707d8
doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
* isplaying.m, isrecording.m, isequal.m, isequaln.m, iscolormap.m,
is_valid_file_id.m, isdir.m, isstr.m, isbanded.m, isdefinite.m, isdiag.m,
ishermitian.m, issymmetric.m, istril.m, istriu.m, isdeployed.m, isfolder.m,
ismac.m, ismethod.m, ispc.m, isunix.m, isaxes.m, isfigure.m, isgraphics.m,
ishandle.m, ishold.m, ispref.m, isprime.m, isletter.m, isstring.m, isstrprop.m,
is_leap_year.m:
Use TF for output variable in documentation for isXXX functions.
Change variable name in code function prototype to match documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 27 Dec 2021 16:07:08 -0800 |
| parents | 7854d5752dd2 |
| children | 83f9f8bda883 |
line wrap: on
line diff
--- a/scripts/image/iscolormap.m Mon Dec 27 15:51:12 2021 -0800 +++ b/scripts/image/iscolormap.m Mon Dec 27 16:07:08 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {} iscolormap (@var{cmap}) +## @deftypefn {} {@var{tf} =} iscolormap (@var{cmap}) ## Return true if @var{cmap} is a colormap. ## ## A colormap is a real matrix, of class single or double, with 3 columns. @@ -38,15 +38,14 @@ ## @seealso{colormap, rgbplot} ## @end deftypefn -function retval = iscolormap (cmap) +function tf = iscolormap (cmap) if (nargin < 1) print_usage (); endif - retval = (isnumeric (cmap) && isreal (cmap) - && ndims (cmap) == 2 && columns (cmap) == 3 - && isfloat (cmap)); + tf = isnumeric (cmap) && isreal (cmap) && isfloat (cmap) ... + && ndims (cmap) == 2 && columns (cmap) == 3; endfunction