changeset 13786:40dab5d70115

Clarify the third argument of max/min.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 01 Nov 2011 23:18:08 -0400
parents daf81e42960c
children 8bb7bdbe9c69
files src/DLD-FUNCTIONS/max.cc
diffstat 1 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/max.cc	Tue Nov 01 20:48:22 2011 -0400
+++ b/src/DLD-FUNCTIONS/max.cc	Tue Nov 01 23:18:08 2011 -0400
@@ -313,7 +313,8 @@
 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} min (@var{x})\n\
 For a vector argument, return the minimum value.  For a matrix\n\
 argument, return the minimum value from each column, as a row\n\
-vector, or over the dimension @var{dim} if defined.  For two matrices\n\
+vector, or over the dimension @var{dim} if defined, in which case @vary{y} \n\
+should be set to the empty matrix (it's ignored otherwise).  For two matrices\n\
 (or a matrix and scalar), return the pair-wise minimum.\n\
 Thus,\n\
 \n\
@@ -390,7 +391,8 @@
 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} max (@var{x})\n\
 For a vector argument, return the maximum value.  For a matrix\n\
 argument, return the maximum value from each column, as a row\n\
-vector, or over the dimension @var{dim} if defined.  For two matrices\n\
+vector, or over the dimension @var{dim} if defined, in which case @vary{y} \n\
+should be set to the empty matrix (it's ignored otherwise).  For two matrices\n\
 (or a matrix and scalar), return the pair-wise maximum.\n\
 Thus,\n\
 \n\