Skip to content

Commit c0a1279

Browse files
committed
DOC: Updated to_df() doc
1 parent 36b8b5a commit c0a1279

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

databento/common/dbnstore.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -880,6 +880,10 @@ def to_df(
880880
"""
881881
Return the data as a `pd.DataFrame`.
882882
883+
Notes
884+
-----
885+
The DataFrame index will be set to `ts_recv` if it exists in the schema, otherwise it will be set to `ts_event`.
886+
883887
Parameters
884888
----------
885889
price_type : PriceType or str, default "float"

0 commit comments

Comments
 (0)