wassname/catalyst
1
0
Fork 0
mirror of https://github.com/wassname/catalyst.git synced 2026-06-28 16:28:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOC: Added doc-string to get_data().

Browse Source
This commit is contained in:
Thomas Wiecki
2012-11-19 10:23:22 -05:00
parent 4c02fea6e2
commit f2ce713b99
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
zipline/transforms/utils.py
+9 -8
View File
@@ -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.
#