From 5392506d6d0cc62af6ccc9fe404be6ae9eb1b000 Mon Sep 17 00:00:00 2001 From: Scott Sanderson Date: Fri, 16 May 2014 13:44:08 -0400 Subject: [PATCH] DOC: Documentation fixups in `history_container.py.` --- zipline/history/history_container.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/zipline/history/history_container.py b/zipline/history/history_container.py index 03bc54e1..e7b74b86 100644 --- a/zipline/history/history_container.py +++ b/zipline/history/history_container.py @@ -25,7 +25,7 @@ from . history import ( from zipline.finance import trading from zipline.utils.data import RollingPanel -# The closing price is referred to be multiple names, +# The closing price is referred to by multiple names, # allow both for price rollover logic etc. CLOSING_PRICE_FIELDS = {'price', 'close_price'} @@ -68,13 +68,15 @@ class HistoryContainer(object): """ Container for all history panels and frames used by an algoscript. - To be used internally by algoproxy, but *not* passed directly to the + To be used internally by TradingAlgorithm, but *not* passed directly to the algorithm. + Entry point for the algoscript is the result of `get_history`. """ def __init__(self, history_specs, initial_sids, initial_dt): - # All of the history specs found by the algoscript parsing. + + # History specs to be served by this container. self.history_specs = history_specs # The overaching panel needs to be large enough to contain the @@ -94,8 +96,8 @@ class HistoryContainer(object): self.current_day_panel = create_current_day_panel( self.fields, initial_sids, initial_dt) - # Helps prop up the prior day panel against having a nan, when - # the data has been seen. + # Helps prop up the prior day panel against having a nan, when the data + # has been seen. self.last_known_prior_values = {field: {} for field in self.fields} # Populating initial frames here, so that the cost of creating the