bug 6946 add informations about optional input arguments

Change-Id: I8ca2fe6d0a305bba4c6d303c8b9bd8061bfe1acd

diff --git a/scilab/CHANGES_5.3.X b/scilab/CHANGES_5.3.X
index fe4aa5a..b18dd01 100644 (file)
--- a/scilab/CHANGES_5.3.X
+++ b/scilab/CHANGES_5.3.X
@@ -471,6 +471,9 @@ Bug fixes:
 
 * bug 6940 fixed - An error message was wrong in 'pvm_send'.
 
+* bug 6946 fixed - information about optional input arguments 'column separator'
+                   and 'decimal mark' were missing in the write_csv documentation.
+
 * bug 6947 fixed - Some demos in "Optimization and Simulation" failed, 
                    without write rights in SCI subdirectory.
 

diff --git a/scilab/modules/spreadsheet/help/en_US/write_csv.xml b/scilab/modules/spreadsheet/help/en_US/write_csv.xml
index 29f8018..30b763c 100644 (file)
--- a/scilab/modules/spreadsheet/help/en_US/write_csv.xml
+++ b/scilab/modules/spreadsheet/help/en_US/write_csv.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) 2009 - DIGITEO - Allan CORNET
+ * Copyright (C) 2009-2010 - DIGITEO - Allan CORNET
  *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
@@ -30,7 +30,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
 
-    <synopsis>write_csv(M, filename)</synopsis>
+    <synopsis>write_csv(M, filename [,sep, dec])</synopsis>
   </refsynopsisdiv>
 
   <refsection>
@@ -52,6 +52,24 @@
           <para>a matrix of strings.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term>sep</term>
+
+        <listitem>
+          <para>column separator mark, by default a tabulation: ascii(9)</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>dec</term>
+
+        <listitem>
+          <para>decimal mark '.' or ',' by default a ','</para>
+        </listitem>
+      </varlistentry>
+
+      
     </variablelist>
   </refsection>
 
@@ -60,6 +78,7 @@
 
     <para>write_csv(M, filename) writes matrix M into filename as
     comma-separated values. The filename input is a string.</para>
+    <para>if the file 'filename' already exists, it is overwritten.</para>
   </refsection>
 
   <refsection>
@@ -74,7 +93,13 @@ mgetl(TMPDIR + '/datas.csv')
 
 r = read_csv(TMPDIR + '/datas.csv',ascii(9));
 r = strsubst(r,',','.');
-evstr(r)</programlisting>
+evstr(r)
+
+A = [1:10] * 0.1; 
+write_csv(A', TMPDIR+'/foo.csv', ' ', '.');
+mgetl(TMPDIR+'/foo.csv')
+
+</programlisting>
   </refsection>
 
   <refsection>
@@ -86,6 +111,8 @@ evstr(r)</programlisting>
       <member><link linkend="evstr">evstr</link></member>
 
       <member><link linkend="mgetl">mgetl</link></member>
+      
+      <member><link linkend="format">format</link></member>
     </simplelist>
   </refsection>
 

diff --git a/scilab/modules/spreadsheet/macros/write_csv.sci b/scilab/modules/spreadsheet/macros/write_csv.sci
index 103d0a2..ceadc01 100644 (file)
--- a/scilab/modules/spreadsheet/macros/write_csv.sci
+++ b/scilab/modules/spreadsheet/macros/write_csv.sci
@@ -1,6 +1,6 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA
-// Copyright (C) 2009 - DIGITEO - Allan CORNET
+// Copyright (C) 2009-2010 - DIGITEO - Allan CORNET
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -22,6 +22,10 @@ function write_csv(var, fname, sep, dec)
     sep = ascii(9);
   end
   
+  if sep == '\t' then
+    sep = ascii(9);
+  end
+  
   if exists('dec','local') == 0 then
     dec = ',';
   end

diff --git a/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.dia.ref b/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.dia.ref
index 7ce29e3..35e44c2 100644 (file)
--- a/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.dia.ref
+++ b/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.dia.ref
@@ -1,6 +1,6 @@
 // =============================================================================
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2008 - DIGITEO - Allan CORNET
+// Copyright (C) 2008-2010 - DIGITEO - Allan CORNET
 //
 //  This file is distributed under the same license as the Scilab package.
 // =============================================================================
@@ -11,4 +11,7 @@ ref1 = [ 0 1 2 3 4 5 6 7 8 9 ;
         40 41 42 43 44 45 46 47 48 49 ];
 write_csv(ref1, TMPDIR + '/test.csv');
 res = read_csv( TMPDIR + '/test.csv');
-if and(evstr(res) <> ref1) then bugmes();quit;end
+if or(evstr(res) <> ref1) then bugmes();quit;end
+write_csv(ref1, TMPDIR + '/test2.csv', ' ', '.');
+res = read_csv( TMPDIR + '/test2.csv', ' ');
+if or(evstr(res) <> ref1) then bugmes();quit;end

diff --git a/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.tst b/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.tst
index 035a8a9..c83f01b 100644 (file)
--- a/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.tst
+++ b/scilab/modules/spreadsheet/tests/unit_tests/readwrite_csv.tst
@@ -1,6 +1,6 @@
 // =============================================================================
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2008 - DIGITEO - Allan CORNET
+// Copyright (C) 2008-2010 - DIGITEO - Allan CORNET
 //
 //  This file is distributed under the same license as the Scilab package.
 // =============================================================================
@@ -14,4 +14,9 @@ ref1 = [ 0 1 2 3 4 5 6 7 8 9 ;
 write_csv(ref1, TMPDIR + '/test.csv');
 res = read_csv( TMPDIR + '/test.csv');
 
-if and(evstr(res) <> ref1) then pause,end
\ No newline at end of file
+if or(evstr(res) <> ref1) then pause, end
+
+write_csv(ref1, TMPDIR + '/test2.csv', ' ', '.');
+res = read_csv( TMPDIR + '/test2.csv', ' ');
+
+if or(evstr(res) <> ref1) then pause, end