changeset 10824:1e6664326d32

rsf2csf: Change first documentation line to active voice.
author Rik <octave@nomad.inbox5.com>
date Tue, 27 Jul 2010 10:46:11 -0700
parents 3d89d262f5d4
children cace99cb01ab
files src/ChangeLog src/DLD-FUNCTIONS/schur.cc
diffstat 2 files changed, 8 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Tue Jul 27 12:31:58 2010 +0200
+++ b/src/ChangeLog	Tue Jul 27 10:46:11 2010 -0700
@@ -1,3 +1,8 @@
+2010-07-27  Rik <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/schur.cc (rsf2csf): Change first documentation line to
+	active voice.
+
 2010-07-27  Jaroslav Hajek  <highegg@gmail.com>
 
 	* DLD-FUNCTIONS/schur.cc (Frsf2csf): New DEFUN.
--- a/src/DLD-FUNCTIONS/schur.cc	Tue Jul 27 12:31:58 2010 +0200
+++ b/src/DLD-FUNCTIONS/schur.cc	Tue Jul 27 10:46:11 2010 -0700
@@ -394,13 +394,13 @@
 DEFUN_DLD (rsf2csf, args, nargout,
   "-*- texinfo -*-\n\
 @deftypefn {Function File} {[@var{U}, @var{T}] =} rsf2csf (@var{UR}, @var{TR})\n\
-Converts a real, upper quasi-triangular Schur form @var{TR} to a complex,\n\
+Convert a real, upper quasi-triangular Schur form @var{TR} to a complex,\n\
 upper triangular Schur form @var{T}.\n\
 \n\
 Note that the following relations hold: \n\
 \n\
 @code{@var{UR} * @var{TR} * @var{UR}' = @var{U} * @var{T} * @var{U}'} and\n\
-@code{@var{U}' * @var{U}} is identity.\n\
+@code{@var{U}' * @var{U}} is the identity matrix.\n\
 \n\
 Note also that U and T are not unique.\n\
 \n\
@@ -415,7 +415,7 @@
       else if (! args(1).is_numeric_type ())
         gripe_wrong_type_arg ("rsf2csf", args(1));
       else if (args(0).is_complex_type () || args(1).is_complex_type ())
-        error ("rsf2csf: both matrices should be real");
+        error ("rsf2csf: both matrices must be real");
       else
         {