From f2ce713b992dcba6775bb381f3bb689effde347a Mon Sep 17 00:00:00 2001 From: Thomas Wiecki Date: Mon, 19 Nov 2012 10:23:22 -0500 Subject: [PATCH] DOC: Added doc-string to get_data(). --- zipline/transforms/utils.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/zipline/transforms/utils.py b/zipline/transforms/utils.py index 4da8926a..22745808 100644 --- a/zipline/transforms/utils.py +++ b/zipline/transforms/utils.py @@ -417,14 +417,15 @@ class BatchTransform(EventWindow): self.updated = False def get_data(self): - # Create a pandas.Panel (i.e. 3d DataFrame) from the - # events in the current window. - # - # The resulting panel looks like this: - # index : field_name (e.g. price) - # major axis/rows : dt - # minor axis/colums : sid - # + """Create a pandas.Panel (i.e. 3d DataFrame) from the + events in the current window. + + Returns: + The resulting panel looks like this: + index : field_name (e.g. price) + major axis/rows : dt + minor axis/colums : sid + """ # This Panel data structure ultimately gets passed to the # user-overloaded get_value() method. #