Revision of help page for clean function. 90/9090/1
Stanislav KROTER [Thu, 20 Sep 2012 13:39:09 +0000 (19:39 +0600)]
Change-Id: Ib13f91f61b81cce932abccbd2a9f6f70f07f70d3

scilab/modules/elementary_functions/help/en_US/floating_point/clean.xml

index eab8340..afebb66 100644 (file)
             <varlistentry>
                 <term>A</term>
                 <listitem>
-                    <para>a numerical matrix (scalar, polynomial, sparse...)</para>
+                    <para>a numerical matrix (scalar, polynomial, sparse, ...).</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>epsa,epsr</term>
+                <term>epsa, epsr</term>
                 <listitem>
-                    <para>real numbers. Cleaning tolerances (default values resp. 1.d-10 and 1.d-10)</para>
+                    <para>real numbers. Cleaning tolerances (default values resp. <literal>1.d-10</literal> and <literal>1.d-10</literal>).</para>
                 </listitem>
             </varlistentry>
         </variablelist>
         <title>Description</title>
         <para>
             This function eliminates (i.e. set to zero) all the coefficients
-            with absolute value &lt; <literal>epsa</literal> or relative value &lt; <literal>epsr</literal>
-            (relative means relative w.r.t. 1-norm of coefficients)
+            with absolute value &lt; <varname>epsa</varname> or relative value &lt; <varname>epsr</varname>
+            (relative means relative w.r.t. <literal>1-norm</literal> of coefficients)
             in a polynomial (possibly matrix polynomial or rational
             matrix).
         </para>
         <para>
-            Default  values are <literal>epsa=1.d-10</literal> and <literal>epsr=1.d-10;</literal>
+            Default  values are <varname>epsa</varname><literal>=1.d-10</literal> and <varname>epsr</varname><literal>=1.d-10;</literal>
         </para>
         <para>
-            For a constant (non polynomial) matrix <literal>clean(A,epsa)</literal> sets to zero all
-            entries of <literal>A</literal> smaller than <literal>epsa</literal>.
+            For a constant (non-polynomial) matrix <code>clean(A,epsa)</code> sets to zero all
+            entries of <literal>A</literal> smaller than <varname>epsa</varname>.
         </para>
     </refsection>
     <refsection>