Skip to content

Commit 2b7ecfe

Browse files
Joe Jevnikllllllllll
authored andcommitted
DOC: update docstring for mutlidimensionaldataset
1 parent 14ef1d3 commit 2b7ecfe

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

zipline/pipeline/data/dataset.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,10 @@ def __new__(cls, name, bases, dict_):
560560
columns = {}
561561
for k, v in dict_.items():
562562
if isinstance(v, Column):
563+
# capture all the columns off the MultiDimensionalDataSet class
564+
# and replace them with a descriptor that will raise a helpful
565+
# error message. The columns will get added to the BaseSlice
566+
# for this type.
563567
columns[k] = v
564568
dict_[k] = _MultiDimensionalDataSetColumn(k)
565569

@@ -651,7 +655,7 @@ class SomeDataSet(MultiDimensionalDataSet):
651655
column_0 = Column('f8')
652656
column_1 = Column('?')
653657
654-
This represents a table with the following columns:
658+
This dataset might represent a table with the following columns:
655659
656660
::
657661

0 commit comments

Comments
 (0)