From 3af850948cd760f769adb3fbf7800a12767916d2 Mon Sep 17 00:00:00 2001 From: fawce Date: Fri, 16 Mar 2012 17:56:53 -0400 Subject: [PATCH] fixed documentation on event callback method. --- zipline/finance/trading.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/zipline/finance/trading.py b/zipline/finance/trading.py index e6119a8e..a7d0e65b 100644 --- a/zipline/finance/trading.py +++ b/zipline/finance/trading.py @@ -39,7 +39,9 @@ class TradeSimulationClient(qmsg.Component): def add_event_callback(self, callback): """ :param callable callback: must be a function with the signature - f(frame). + f(event), where event is a namedict whose properties depend on the + upstream configuration of the zipline. It will include datasource and + transformations. """ self.event_callbacks.append(callback)