From ec3c370c11926ce38be38380860b790f6edfa1ad Mon Sep 17 00:00:00 2001 From: Scott Sanderson Date: Thu, 25 Feb 2016 17:56:38 -0500 Subject: [PATCH] DOC: Update docs on BoundColumn. --- zipline/pipeline/data/dataset.py | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/zipline/pipeline/data/dataset.py b/zipline/pipeline/data/dataset.py index 0362a183..2207a70b 100644 --- a/zipline/pipeline/data/dataset.py +++ b/zipline/pipeline/data/dataset.py @@ -89,7 +89,23 @@ class _BoundColumnDescr(object): class BoundColumn(Term): """ - A Column of data that's been concretely bound to a particular dataset. + A column of data that's been concretely bound to a particular dataset. + + Instances of this class are dynamically created upon access to attributes + of DataSets. + + Attributes + ---------- + dtype : numpy.dtype + The dtype of data produced when this column is loaded. + latest : zipline.pipeline.data.Factor or zipline.pipeline.data.Filter + A Filter/Factor computing the most recently known value of this column + on each date. Produces a Filter if self.dtype == np.bool_, otherwise + produces a Factor. + dataset : zipline.pipeline.data.DataSet + The dataset to which this column is bound. + name : str + The name of this column. """ mask = AssetExists() extra_input_rows = 0 @@ -120,16 +136,24 @@ class BoundColumn(Term): @property def dataset(self): + """ + The dataset to which this column is bound. + """ return self._dataset @property def name(self): + """ + The name of this column. + """ return self._name @property def qualname(self): """ - Fully qualified of this column. + The fully-qualified of this column. + + Generated by doing '.'.join([self.dataset.__name__, self.name]). """ return '.'.join([self.dataset.__name__, self.name])