* Bug #13175 fixed - Update argn() help page. 81/13581/2
Charlotte HECQUET [Tue, 28 Jan 2014 16:39:05 +0000 (17:39 +0100)]
Change-Id: I41640c149c8fe1664ad18a1e29288eef7ced4943

scilab/CHANGES_5.5.X
scilab/modules/functions/help/en_US/argn.xml
scilab/modules/functions/help/fr_FR/argn.xml

index 04ed836..baf0819 100644 (file)
@@ -462,6 +462,8 @@ Xcos
 
 * Bug #13172 fixed - Logic bloc help file had some typo.
 
+* Bug #13175 fixed - argn help page updated with specific cases.
+
 
                  Changes between version 5.4.1 and 5.5.0-beta-1
                  ==============================================
index f0b9d5a..ba28b5b 100644 (file)
         <title>Description</title>
         <para>
             This function is used inside a function definition.
-            It gives the number of actual inputs arguments (<literal>rhs</literal>)
-            and output arguments (<literal>lhs</literal>) passed to the function when the function is 
+            It gives the number of actual inputs arguments (<varname>rhs</varname>)
+            and output arguments (<varname>lhs</varname>) passed to the function when the function is 
             called. It is usually used in function definitions to deal with 
             optional arguments.
         </para>
+        <para>
+            Note that <varname>lhs</varname> is always greater than or equal to 1. That is to say, even if a function
+            is called without having mentioned an output argument, <varname>lhs</varname> will be equal to 1.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 function concat=myOwnFunction(name,optional)
-  [lhs,rhs]=argn(0) 
+  [lhs,rhs]=argn(0);
+  disp(lhs);
   if rhs <= 1 then
-        optional="my Optional value"
+        optional="my Optional value";
   end
   if rhs == 0 then
-        error("Expect at least one argument")
+        error("Expect at least one argument");
   end
-  concat=name+" "+optional
+  concat=name+" "+optional;
 endfunction
  ]]></programlisting>
     </refsection>
index 3ccfb66..f0b3fc2 100644 (file)
         <title>Description</title>
         <para>
             Cette fonction est utilisée à l'intérieur d'une définition de fonction.
-            Elle donne le nombre effectif (au moment de l'appel) d'arguments d'entrée <literal>rhs</literal>
-            et de sortie <literal>lhs</literal>. Elle permet d'utiliser des arguments optionnels.
+            Elle donne le nombre effectif (au moment de l'appel) d'arguments d'entrée <varname>rhs</varname>
+            et de sortie <varname>lhs</varname>. Elle permet d'utiliser des arguments optionnels.
         </para>
+        <para>
+            Notez que <varname>lhs</varname> est toujours supérieur ou égal à 1. Autrement dit, même si une
+            fonction est appelée sans avoir mentionné un argument de sortie, <varname>lhs</varname> sera égal à 1.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[ 
+function concat=maFonction(nom,option)
+  [lhs,rhs]=argn(0);
+  disp(lhs);
+  if rhs <= 1 then
+        option="mon argument optionnel";
+  end
+  if rhs == 0 then
+        error("Au moins un argument attendu");
+  end
+  concat=nom+" "+option;
+endfunction
+ ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>