* Bug #12021 fixed - Improve the help page of eigs. 57/10157/3
Sylvestre Ledru [Tue, 8 Jan 2013 16:21:30 +0000 (17:21 +0100)]
Change-Id: Ie0ef66e08c1eff8ab94625cedc73262f3591839b

scilab/CHANGES_5.4.X
scilab/modules/arnoldi/help/en_US/eigs.xml

index 93373ca..d4cda8e 100644 (file)
@@ -106,8 +106,6 @@ Xcos
 * Bug #11988 fixed - Copying or dragging AFFICH_m block threw Java
                      NullPointerException.
 
-* Bug #11998 fixed - listvar_in_hdf5 did not close the hdf5 file.
-
 * Bug #12101 fixed - Port ordering was not preserved on parameters change.
 
 * Bug #12014 fixed - dep_ut help was wrongly detailed.
@@ -203,6 +201,8 @@ Bug fixes
 
 * Bug #11991 fixed - Under Windows, some empty lines were added by csvWrite.
 
+* Bug #11998 fixed - listvar_in_hdf5 did not close the hdf5 file.
+
 * Bug #11999 fixed - Blank lines ignored by default by csvRead / read_csv.
 
 * Bug #12003 fixed - Fix a typo in the spreadsheet module.
@@ -237,6 +237,8 @@ Bug fixes
 
 * Bug #12120 fixed - eigs was broken for complex sparse matrices.
 
+* Bug #12021 fixed - Improve the help page of eigs.
+
 * Bug #12135 fixed - stacksize('max') failed silently.
 
 * Bug #12137 fixed - eigs(A,B) returned incorrect result for sparse matrices.
index cd42cbb..f545ebb 100644 (file)
@@ -13,7 +13,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="eigs" xml:lang="en">
     <refnamediv>
         <refname>eigs</refname>
-        <refpurpose>calculates eigenvalues and eigenvectors of matrices</refpurpose>
+        <refpurpose>calculates largest eigenvalues and eigenvectors of matrices</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         </variablelist>
     </refsection>
     <refsection>
-        <title>Description</title>
-        <variablelist>
+      <title>Description</title>
+      <para>
+        The purpose of the eigs function is to compute the largest eigenvalues of sparse, large matrices.
+      </para>
+      <variablelist>
             <varlistentry>
                 <term>d = eigs(A) or d = eigs(Af, n)</term>
                 <listitem>