changeset 6174:d3c599afc455

[project @ 2006-11-16 17:52:02 by jwe]
author jwe
date Thu, 16 Nov 2006 17:52:02 +0000
parents dae08571782e
children a4ecbadedc17
files src/ChangeLog src/data.cc
diffstat 2 files changed, 15 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Thu Nov 16 17:26:26 2006 +0000
+++ b/src/ChangeLog	Thu Nov 16 17:52:02 2006 +0000
@@ -1,3 +1,7 @@
+2006-11-16  John W. Eaton  <jwe@octave.org>
+
+	* data.cc (Fresize): Fix doc string.
+
 2006-11-15  John W. Eaton  <jwe@octave.org>
 
 	* DLD-FUNCTIONS/__gnuplot_raw__.l (write_data, write_inline_data):
--- a/src/data.cc	Thu Nov 16 17:26:26 2006 +0000
+++ b/src/data.cc	Thu Nov 16 17:52:02 2006 +0000
@@ -2348,11 +2348,17 @@
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} resize (@var{x}, @var{m})\n\
 @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n})\n\
-Resize @var{x} to be dimension @var{m}-by-@var{n} where @var{m}\n\
-and @var{n} are scalar. If @var{n} is not supplied, then resize @var{x}\n\
-to be dimension @var{m}-by-@var{m} if @var{m} is scalar, or if\n\
-@var{m} is a vector, then the values of this vector respresent the\n\
-dimensions of the resized matrix.\n\
+Destructively resize @var{x}.\n\
+\n\
+@strong{Values in @var{x} are not preserved as they are with\n\
+@code{reshape}}.\n\
+\n\
+If only @var{m} is supplied and it is a scalar, the dimension of the\n\
+result is @var{m}-by-@var{m}.  If @var{m} is a vector, then the\n\
+dimensions of the result are given by the elements of @var{m}.\n\
+If both @var{m} and @var{n} are scalars, then the dimensions of\n\
+the result are @var{m}-by-@var{n}.\n\
+@seealso{reshape}\n\
 @end deftypefn")
 {
   octave_value retval;