* Bug #12859 fixed - Core doc: fix optional argument of isdef() 74/12374/1
Paul BIGNIER [Wed, 28 Aug 2013 07:21:57 +0000 (09:21 +0200)]
Change-Id: Id6d1beec5311a7bb7950d821073fb945d0afb77d

scilab/CHANGES_5.5.X
scilab/modules/core/help/en_US/variables/isdef.xml
scilab/modules/core/help/fr_FR/variables/isdef.xml

index 497a8a1..d23005b 100644 (file)
@@ -580,3 +580,5 @@ Bug fixes
 * Bug #12852 fixed - Visual Studio 2012 SDK configuration is incorrect.
 
 * Bug #12858 fixed - Typo in French doc for debug() and pause().
+
+* Bug #12859 fixed - Core doc: fix optional argument of isdef().
index 106a62f..0edcf03 100644 (file)
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - 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    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
             <varlistentry>
                 <term>where</term>
                 <listitem>
-                    <para>an optional character string with default value
-                        <literal>'all'</literal>
+                    <para>
+                        character string, can be <literal>'l'</literal> (for <literal>"local"</literal>),
+                        <literal>'n'</literal> (for <literal>"nolocal"</literal>) or
+                        <literal>'a'</literal> (for <literal>"all"</literal>). Default value is
+                        <literal>'a'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             result which depends on the environment!
         </para>
         <para>
-            <literal>isdef(name,'local')</literal> returns <literal>%T</literal>
+            <literal>isdef(name, 'l')</literal> returns <literal>%T</literal>
             if the variable named <literal>name</literal> exists in the local
             environment of the current function and <literal>%F</literal>
             otherwise.
         </para>
         <para>
-            <literal>isdef(name,'nolocal')</literal> returns
+            <literal>isdef(name, 'n')</literal> returns
             <literal>%T</literal> if the variable named <literal>name</literal> exists
             in the full calling environment (including the global level) of the
             current function and <literal>%F</literal> otherwise.
         </para>
+        <para>
+            Note: only the first letter of option <literal>where</literal> is taken into account.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-A=1; B=2; C=3; D=4;
+        <programlisting role="example"><![CDATA[
+A = 1; B = 2; C = 3; D = 4;
 isdef(['A', 'B'; 'C', 'D'])
 clear A, B, C, D;
 isdef(['A', 'B'; 'C', 'D'])
 
 function level1()
   function level2()
-    disp(isdef(["a", "b"],"all"));
-    disp(isdef(["a", "b"],"local"));
-    disp(isdef(["a", "b"],"nolocal"));
+    disp(isdef(["a", "b"], "all"));
+    disp(isdef(["a", "b"], "local"));
+    disp(isdef(["a", "b"], "nolocal"));
   endfunction
   level2()
 endfunction
 function go()
-  a=1;
+  a = 1;
   level1()
 endfunction
 go()
index dec00ef..fd7c922 100644 (file)
@@ -14,7 +14,9 @@
             <varlistentry>
                 <term>ve</term>
                 <listitem>
-                    <para>une matrice de booléens de même taille que <varname>name</varname> </para>
+                    <para>
+                        une matrice de booléens de même taille que <varname>name</varname>
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>where</term>
                 <listitem>
-                    <para>une chaîne de caractères optionnelle valant par défaut
-                        <literal>'all'</literal>
+                    <para>
+                        chaîne de caractères, peut valoir <literal>'l'</literal> (pour <literal>"local"</literal>),
+                        <literal>'n'</literal> (pour <literal>"nolocal"</literal>) ou
+                        <literal>'a'</literal> (pour <literal>"all"</literal>). Par défaut, vaut
+                        <literal>'a'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             renvoyer un résultat dépendant de l'environnement courant !
         </para>
         <para>
-            <literal>isdef(name,'local')</literal> renvoie <literal>%T</literal>
+            <literal>isdef(name, 'l')</literal> renvoie <literal>%T</literal>
             si la variable nommée <literal>name</literal> existe dans l'environnement
             local de la fonction courante et <literal>%F</literal> sinon.
         </para>
         <para>
-            <literal>isdef(name,'nolocal')</literal> renvoie
+            <literal>isdef(name, 'n')</literal> renvoie
             <literal>%T</literal> si la variable nommée <literal>name</literal> existe
             dans l'environnement appelant (y compris le niveau global) de la fonction
             courante et <literal>%F</literal> sinon.
         </para>
+        <para>
+            Remarque : seule la première lettre de l'option <literal>where</literal> est prise en compte.
+        </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
-        <programlisting role="example"><![CDATA[ 
-A=1; B=2; C=3; D=4;
+        <programlisting role="example"><![CDATA[
+A = 1; B = 2; C = 3; D = 4;
 isdef(['A', 'B'; 'C', 'D'] )
 clear A, B, C, D;
 isdef(['A', 'B'; 'C', 'D')
 
 function level1()
   function level2()
-    disp(isdef(["a", "b"],"all"));
-    disp(isdef(["a", "b"],"local"));
-    disp(isdef(["a", "b"],"nolocal"));
+    disp(isdef(["a", "b"], "a"));
+    disp(isdef(["a", "b"], "l"));
+    disp(isdef(["a", "b"], "n"));
   endfunction
   level2()
 endfunction
 function go()
-  a=1;
+  a = 1;
   level1()
 endfunction
 go()