Mercurial > hg > octave-nkf

diff scripts/general/isvector.m @ 11431:0d9640d755b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docstrings for all isXXX functions. Use 'return true' rather than 'return 1'. Improve the cross-referencing through seealso links.
author Rik <octave@nomad.inbox5.com>
date Fri, 31 Dec 2010 13:20:44 -0800
parents eb63fbe60fab
children fd0a3ac60b0e
line wrap: on
line diff
--- a/scripts/general/isvector.m
+++ b/scripts/general/isvector.m
@@ -17,9 +17,11 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} isvector (@var{a})
-## Return 1 if @var{a} is a vector.  Otherwise, return 0.
-## @seealso{size, rows, columns, length, isscalar, ismatrix}
+## @deftypefn {Function File} {} isvector (@var{x})
+## Return true if @var{x} is a vector.  A vector is a 2-D array
+## where one of the dimensions is equal to 1.  As a consequence a
+## 1x1 array, or scalar, is also a vector.
+## @seealso{isscalar, ismatrix, size, rows, columns, length}
 ## @end deftypefn
 
 ## Author: jwe