Update README.rst

doruirimescu · Jun 6, 2024 · ab2758b · ab2758b
1 parent 02e08c5
commit ab2758b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -82,8 +82,10 @@ Usage
 
    class MyDataProcessor(StatefulDataProcessor):
 
-    def process_item(self, item, delay):
-        # Process the item
+    def process_item(self, item, iteration_index: int, delay: float):
+        ''' item and iteration_index are automatically supplied by the framework.
+         iteration_index may or may not be used.
+        '''
         self.data[item] = item ** 2  # Example processing: square the item
         time.sleep(delay)