Bug 12836 fixed: There was an error in strcmpi documentation 01/12301/2
Calixte DENIZET [Mon, 19 Aug 2013 16:57:23 +0000 (18:57 +0200)]
Change-Id: I42450fe523887601688ab252b28954cce10fe826

scilab/CHANGES_5.5.X
scilab/modules/string/help/en_US/strcmp.xml
scilab/modules/string/help/en_US/strcmpi.xml

index fe8554e..a39ed36 100644 (file)
@@ -540,4 +540,6 @@ Bug fixes
 
 * Bug #12816 fixed - Numbers pasted in editvar were not parsed according to locale.
 
+* Bug #12836 fixed - There was an error in strcmpi documentation.
+
 * Bug #12840 fixed - Fix typo in number_properties.xml.
index b1f90b6..6279801 100644 (file)
@@ -66,7 +66,7 @@
             The value greater than zero indicates that the first character that
             does not match has a greater value in <varname>string_one</varname>
             than in <varname>string_two</varname> and the value less than zero
-            indicates the opposite.
+            indicates the opposite (lexicographical order).
         </para>
         <para>
             The value equal zero indicates that <varname>string_one</varname>
index 5260366..261800c 100644 (file)
         <title>Description</title>
         <para>
             <code>res = strcmpi(string_one, string_two)</code> returns an
-            integral value indicating the relationship between the strings.
+            integral value indicating the relationship between the strings. The two strings are compared in using the <emphasis role="bold">lexicographical order</emphasis>.
         </para>
         <para>
             The value is <literal>0</literal> if <varname>string_one</varname>
-            is equal to <varname>string_two</varname> (case independently) and
-            <literal>1</literal> indicates the opposite.
+            is equal to <varname>string_two</varname> (case independently),
+            <literal>1</literal> if <varname>string_one</varname> is greater than <varname>string_two</varname> and <literal>-1</literal> else.
         </para>
     </refsection>
     <refsection>