From 8ac6a177c9a067197e33722d5cd31bb8b5412a26 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 31 Aug 2022 10:49:31 +0200
Subject: Adding a comment about TimeStampedBuffer as_dataframe method.

---
 src/argaze/DataStructures.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/argaze/DataStructures.py b/src/argaze/DataStructures.py
index 9352ad8..ffdfe8b 100644
--- a/src/argaze/DataStructures.py
+++ b/src/argaze/DataStructures.py
@@ -94,7 +94,7 @@ class TimeStampedBuffer(collections.OrderedDict):
             raise RuntimeError(f'Can\' write {filepath}')
 
     def as_dataframe(self, exclude=[], split={}):
-        """Convert buffer as pandas dataframe."""
+        """Convert buffer as pandas dataframe. Timestamped values must be stored as dictionary where each keys will be related to a column."""
 
         df = pandas.DataFrame.from_dict(self.values())
         df.drop(exclude, inplace=True, axis=True)
-- 
cgit v1.1