String help: fix isnum 39/13039/2
Paul BIGNIER [Wed, 30 Oct 2013 14:24:33 +0000 (15:24 +0100)]
Following up on commit https://codereview.scilab.org/#/c/13038/

Change-Id: I9d88bb4864e622a64c80f899bf57d465bd5ffdf7

scilab/modules/string/help/en_US/isnum.xml
scilab/modules/string/help/fr_FR/isnum.xml [new file with mode: 0644]

index 08aa861..8b1d6cf 100644 (file)
@@ -49,16 +49,29 @@ xml:lang="en" xml:id="isnum">
             <code>res = isnum(str)</code> returns <constant>%t</constant> if
             <varname>str</varname> represents a number.
         </para>
+        <para>
+            <code>isnum</code> does not handle "operations", but only pure scalar numbers.
+            For instance, <code>isnum("1+2*3")</code> will return <code>%f</code>.
+            Complex numbers are not concerned, because one complex number is defined by the addition of two parts.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-isnum(['1'     , ..
-    '-1.23' , ..
-    '+1e+23', ..
-    '1d+23' , ..
-    'A'     , ..
-    '%pi'])
+isnum(['1'   , ..
+    '-1.23'  , ..
+    '+1e+23' , ..
+    '1d+23'  , ..
+    'A'      , ..
+    '%e'     , ..
+    '%pi'    , ..
+    '%nan'   , ..
+    'Nan'    , ..
+    '%inf'   , ..
+    'Inf'    , ..
+    '1+%i*2' , ..
+    '%eps-%eps*%i', ..
+    '%inf+Nan*%i' ])
     ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -73,6 +86,9 @@ isnum(['1'     , ..
             <member>
                 <link linkend="isalphanum">isalphanum</link>
             </member>
+            <member>
+                <link linkend="evstr">evstr</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
diff --git a/scilab/modules/string/help/fr_FR/isnum.xml b/scilab/modules/string/help/fr_FR/isnum.xml
new file mode 100644 (file)
index 0000000..9552ae7
--- /dev/null
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* Copyright (C) INRIA -
+*
+* This file must be used under the terms of the CeCILL.
+* This source file is licensed as described in the file COPYING, which
+* you should have received as part of this distribution.  The terms
+* are also available at
+* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+*
+-->
+<refentry xmlns="http://docbook.org/ns/docbook"
+xmlns:xlink="http://www.w3.org/1999/xlink"
+xmlns:svg="http://www.w3.org/2000/svg"
+xmlns:mml="http://www.w3.org/1998/Math/MathML"
+xmlns:db="http://docbook.org/ns/docbook"
+xml:lang="fr" xml:id="isnum">
+    <refnamediv>
+        <refname>isnum</refname>
+        <refpurpose>teste si une chaîne de caractères représente un nombre</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Séquence d'appel</title>
+        <synopsis>res = isnum(str)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Paramètres</title>
+        <variablelist>
+            <varlistentry>
+                <term>str</term>
+                <listitem>
+                    <para>
+                        une matrice de chaînes de caractères.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>res</term>
+                <listitem>
+                    <para>une matrice de booléens.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <code>res = isnum(str)</code> retourne <constant>%t</constant> si
+            <varname>str</varname> représente un nombre.
+        </para>
+        <para>
+            <code>isnum</code> ne supporte pas les "opérations", mais seulement des scalaires purs.
+            Par exemple, <code>isnum("1+2*3")</code> retourne <code>%f</code>.
+            Les nombres complexes ne sont pas conernés par cela,
+            puisqu'un nombre complexe est défini par l'addition de deux parties.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+isnum(['1'   , ..
+    '-1.23'  , ..
+    '+1e+23' , ..
+    '1d+23'  , ..
+    'A'      , ..
+    '%e'     , ..
+    '%pi'    , ..
+    '%nan'   , ..
+    'Nan'    , ..
+    '%inf'   , ..
+    'Inf'    , ..
+    '1+%i*2' , ..
+    '%eps-%eps*%i', ..
+    '%inf+Nan*%i' ])
+    ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>Voir aussi</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="isletter">isletter</link>
+            </member>
+            <member>
+                <link linkend="isdigit">isdigit</link>
+            </member>
+            <member>
+                <link linkend="isalphanum">isalphanum</link>
+            </member>
+            <member>
+                <link linkend="evstr">evstr</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>