Changeset 7109 for branches

Timestamp:

May 28, 2009, 9:24:00 AM (15 years ago)

Author:

rwilson

Message:

Documentation changes.

File:

• branches/numpy/anuga/utilities/csv_tools.py (modified) (3 diffs)

branches/numpy/anuga/utilities/csv_tools.py

@@ -13 +13 @@
     '''Select key and value columns from 'N' CSV files, write one CSV file.
 
-    file_title_list: a list of (filename, new_value_column_title) values, one
-                     for each file
+    file_title_list: a list of (filename, new_data_column_title) values, one
+                     for each input file
     output_file:     the output CSV file path
     key_col:         column header string of key column
-    data_col:        column header string of value column
+    data_col:        column header string of data column
 
     The output file will look like:
-        <key_col>,   <new_value_column_title1>, <new_value_column_title2>, ...
-        <key_value>, <data1>,                   <data2>,                   ...
-        <key_value>, <data1>,                   <data2>,                   ...
-        <key_value>, <data1>,                   <data2>,                   ...
-        <key_value>, <data1>,                   <data2>,                   ...
+        <key_col>,   <new_data_column_title1>, <new_data_column_title2>, ...
+        <key_value>, <data1>,                  <data2>,                  ...
+        <key_value>, <data1>,                  <data2>,                  ...
+        <key_value>, <data1>,                  <data2>,                  ...
+        <key_value>, <data1>,                  <data2>,                  ...
 
     There is an assumption that the <key_value> values are the same across
@@ -76 +76 @@
         file_data.append((filename, title, data))
 
-    # now, file_data -> [(filename, title, [(k,v), (k,v), ...]]
+    # now, file_data -> [(filename, title, [(k,v), (k,v), ...], ...]
     # sanity check, check num rows same in all files
     num_rows = None
@@ -103 +103 @@
 
     # write column rows to output file
-    # at this point, file_data=[(<filename>, <col_title>, [(k,v), ...]), ...]
     header = [key_col]
     for (fn, col, d) in file_data: