Mercurial > octave

changeset 28872:808b1a3a1003 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sparse/private/__default_input__.m: Improve used language and style (bug #59235).
author Markus Mützel <markus.muetzel@gmx.de>
date Thu, 08 Oct 2020 19:15:49 +0200
parents 73f04ba59351
children f389a69916c4 4a7890793baf
files scripts/sparse/private/__default__input__.m
diffstat 1 files changed, 13 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/sparse/private/__default__input__.m	Thu Oct 08 18:55:16 2020 +0200
+++ b/scripts/sparse/private/__default__input__.m	Thu Oct 08 19:15:49 2020 +0200
@@ -24,24 +24,24 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {@var{[varargout]} =} __default__input__ (@var{def_val}, @var{varargin})
-## Check if the arguments in input of a function are empty or missing
-## and in such cases sets up them in default values.
+## @deftypefn {} {@var{varargout} =} __default__input__ (@var{def_val}, @var{varargin})
+## Check if the input arguments of a function are empty or missing.
+## If they are, use default values.
 ##
-## The input argoments are:
+## The input arguments are:
 ##
 ## @itemize @minus
 ## @item @var{def_val} is a cell array that contains the values to use
 ## as default.
 ##
-## @item @var{varargin} are the input argument
+## @item @var{varargin} are the input arguments
 ## @end itemize
 ##
-## The output argoments:
+## The output arguments are:
 ##
 ## @itemize @minus
-## @item @var{varargout} all the input argument with filled the empty
-## or missing parameters.
+## @item @var{varargout} all input arguments completed with default
+## values for empty or omitted parameters.
 ##
 ## @end itemize
 ##
@@ -54,9 +54,11 @@
   n = length (varargin);
 
   for i = 1:m
-    if (n < i || isempty (varargin {i}))
-      varargout {i} = def_val {i};
+    if (n < i || isempty (varargin{i}))
+      varargout{i} = def_val{i};
     else
-      varargout {i} = varargin {i};
+      varargout{i} = varargin{i};
     endif
   endfor
+
+endfunction