described the CSV format

Author: felixdivo

can/io/csv.py

@@ -18,16 +18,24 @@
 
 
 class CSVWriter(Listener):
-    """Writes a comma separated text file of
-
-       * timestamp,
-       * arbitration id,
-       * flags (extended, remote, error),
-       * dlc and
-       * data
-
-    for each message received. Each line is terminated with a platform
-    specific line seperator.
+    """Writes a comma separated text file with a line for
+    each message.
+
+    The columns are as follows:
+
+    ================ ======================= ===============
+    name of column   format description      example
+    ================ ======================= ===============
+    timestamp        decimal float           1483389946.197
+    arbitration_id   hex                     0x00dadada
+    extended         1 == True, 0 == False   1
+    remote           1 == True, 0 == False   0
+    error            1 == True, 0 == False   0
+    dlc              int                     6
+    data             base64 encoded          WzQyLCA5XQ==
+    ================ ======================= ===============
+
+    Each line is terminated with a platform specific line seperator.
     """
 
     def __init__(self, filename):