Skip to content

Commit 0e53768

Browse files
committed
DOC: Update API reference descriptions
1 parent 33d9cd4 commit 0e53768

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

databento/historical/api/batch.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,14 @@ def timeseries_submit(
7575
compression : Compression or str {'none', 'zstd'}, default 'zstd'
7676
The data compression mode.
7777
split_duration : Duration or str {'day', 'week', 'month', 'none'}, default 'day'
78-
The time duration split per data file ('week' starts on Sunday UTC).
78+
The maximum time duration before batched data is split into multiple files.
79+
A week starts on Sunday UTC.
7980
split_size : int, optional
80-
The maximum size of each data file on disk before being split.
81+
The maximum size (bytes) of each batched data file before being split.
8182
packaging : Packaging or str {'none', 'zip', 'tar'}, default 'none'
82-
The packaging method for batched data files.
83+
The archive type to package all batched data files in.
8384
delivery : Delivery or str {'download', 's3', 'disk'}, default 'download'
84-
The batch data delivery mechanism.
85+
The delivery mechanism for the processed batched data files.
8586
stype_in : SType or str, default 'native'
8687
The input symbology type to resolve from.
8788
stype_out : SType or str, default 'product_id'

0 commit comments

Comments
 (0)