diff src/DLD-FUNCTIONS/sqrtm.cc @ 12584:7ef7e20057fa stable

Improve documentation strings in Linear Algebra chapter.
author Rik <octave@nomad.inbox5.com>
date Fri, 08 Apr 2011 12:44:40 -0700
parents 12df7854fa7c
children ab529124f516
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/sqrtm.cc	Thu Apr 07 14:44:01 2011 -0700
+++ b/src/DLD-FUNCTIONS/sqrtm.cc	Fri Apr 08 12:44:40 2011 -0700
@@ -214,7 +214,8 @@
 
 DEFUN_DLD (sqrtm, args, nargout,
  "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {[@var{result}, @var{error_estimate}] =} sqrtm (@var{A})\n\
+@deftypefn  {Loadable Function} {@var{s} =} sqrtm (@var{A})\n\
+@deftypefnx {Loadable Function} {[@var{s}, @var{error_estimate}] =} sqrtm (@var{A})\n\
 Compute the matrix square root of the square matrix @var{A}.\n\
 \n\
 Ref: N.J. Higham.  @cite{A New sqrtm for @sc{matlab}}.  Numerical\n\