Improve the description of getd 26/9026/3
Sylvestre Ledru [Mon, 17 Sep 2012 13:27:23 +0000 (15:27 +0200)]
Change-Id: Ifccc746ecd5ce1cc127f199bc54b39cf136934c5

scilab/modules/functions/help/en_US/getd.xml
scilab/modules/functions/help/fr_FR/getd.xml

index 3912411..8ad934d 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getd">
     <refnamediv>
         <refname>getd</refname>
-        <refpurpose> getting all functions defined in a directory</refpurpose>
+        <refpurpose>Load all functions defined in a directory</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>path</term>
                 <listitem>
-                    <para>Scilab string. The directory pathname</para>
+                    <para>A string. The directory pathname</para>
+                    <para>
+                        "." if <link linkend="getd">getd</link> is called without input argument or if <literal>path</literal> is an empty string.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            loads all <literal>.sci</literal> files (containing Scilab functions) defined in
+            Loads all <literal>.sci</literal> files (containing Scilab functions) defined in
             the <literal>path</literal> directory.
         </para>
+        <para>
+            If the file does not contain a function, the script will be executed.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 12506d3..34b6a5e 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="getd">
     <refnamediv>
         <refname>getd</refname>
-        <refpurpose> chargement de toutes les fonctions contenues dans un répertoire  </refpurpose>
+        <refpurpose>Charge toutes les fonctions contenues dans un répertoire.</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
         <synopsis>getd(path)</synopsis>
     </refsynopsisdiv>
     <refsection>
-        <title>Paramètres</title>
+        <title>Argument</title>
         <variablelist>
             <varlistentry>
-                <term>path  </term>
+                <term>path</term>
                 <listitem>
                     <para>chaîne de caractères, chemin du répertoire
                     </para>
+                    <para>
+                        "." si <link linkend="getd">getd</link> est appelée sans argument ou si <literal>path</literal> est une chaîne de caractères vide.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            Charge tous les fichiers <literal>.sci</literal> (contenant des fonctions Scilab) présents dans le répertoire <literal>path</literal>. 
+            Charge tous les fichiers <literal>.sci</literal> (contenant des fonctions Scilab) présents dans le répertoire <literal>path</literal>.
+        </para>
+        <para>
+            Si le fichier ne contient pas de fonction, le script sera executé.
         </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 getd('SCI/modules/cacsd/macros')
  ]]></programlisting>
     </refsection>