Skip to content

Commit 507f1da

Browse files
cjdsellerscjdsellers
committed
DOC: Standardize terminology and update example requests
1 parent 4a84e46 commit 507f1da

File tree

4 files changed

+14
-19
lines changed

4 files changed

+14
-19
lines changed

‎databento/common/enums.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class Duration(Enum):
8383

8484
@unique
8585
class Packaging(Enum):
86-
"""Represents the packaging method for batch data files."""
86+
"""Represents the packaging method for batched data files."""
8787

8888
NONE = "none"
8989
ZIP = "zip"

‎databento/historical/api/batch.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def timeseries_submit(
5757
dataset : Dataset or str
5858
The dataset name for the request.
5959
symbols : List[Union[str, int]] or str, optional
60-
The symbols for the request. If ``None`` then will be for ALL symbols.
60+
The symbols for the request. If ``None`` then will be for **all** symbols.
6161
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
6262
The data record schema for the request.
6363
start : pd.Timestamp or date or str or int, optional
@@ -77,16 +77,15 @@ def timeseries_submit(
7777
split_size : int, optional
7878
The maximum size of each data file on disk before being split.
7979
packaging : Packaging or str {'none', 'zip', 'tar'}, default 'none'
80-
The packaging method for batch data files.
80+
The packaging method for batched data files.
8181
delivery : Delivery or str {'download', 's3', 'disk'}, default 'download'
8282
The batch data delivery mechanism.
8383
stype_in : SType or str, default 'native'
8484
The input symbology type to resolve from.
8585
stype_out : SType or str, default 'product_id'
8686
The output symbology type to resolve to.
8787
limit : int, optional
88-
The maximum number of records for the request.
89-
If ``None`` is passed, then no limit.
88+
The maximum number of records for the request. If ``None`` then no limit.
9089
9190
Returns
9291
-------

‎databento/historical/api/metadata.py‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ def get_shape(
266266
dataset : Dataset or str
267267
The dataset name for the request.
268268
symbols : List[Union[str, int]] or str, optional
269-
The symbols for the request. If ``None`` then will be for ALL symbols.
269+
The symbols for the request. If ``None`` then will be for **all** symbols.
270270
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
271271
The data record schema for the request.
272272
start : pd.Timestamp or date or str or int, optional
@@ -283,7 +283,7 @@ def get_shape(
283283
The input symbology type to resolve from.
284284
limit : int, optional
285285
The maximum number of records to include in the query.
286-
If ``None`` is passed, then no limit.
286+
If ``None`` then no limit.
287287
288288
Returns
289289
-------
@@ -345,7 +345,7 @@ def get_billable_size(
345345
dataset : Dataset or str
346346
The dataset name for the request.
347347
symbols : List[Union[str, int]] or str, optional
348-
The symbols for the request. If ``None`` then will be for ALL symbols.
348+
The symbols for the request. If ``None`` then will be for **all** symbols.
349349
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
350350
The data record schema for the request.
351351
start : pd.Timestamp or date or str or int, optional
@@ -359,8 +359,7 @@ def get_billable_size(
359359
stype_in : SType or str, default 'native'
360360
The input symbology type to resolve from.
361361
limit : int, optional
362-
The maximum number of records to include in the query.
363-
If ``None`` is passed, then no limit.
362+
The maximum number of records to include in the query. If ``None`` then no limit.
364363
365364
Returns
366365
-------
@@ -416,7 +415,7 @@ def get_cost(
416415
mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, default 'historical-streaming'
417416
The data feed mode for the request.
418417
symbols : List[Union[str, int]] or str, optional
419-
The symbols for the request. If ``None`` then will be for ALL symbols.
418+
The symbols for the request. If ``None`` then will be for **all** symbols.
420419
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
421420
The data record schema for the request.
422421
start : pd.Timestamp or date or str or int, optional
@@ -430,8 +429,7 @@ def get_cost(
430429
stype_in : SType or str, default 'native'
431430
The input symbology type to resolve from.
432431
limit : int, optional
433-
The maximum number of records to include in the query.
434-
If ``None`` is passed, then no limit.
432+
The maximum number of records to include in the query. If ``None`` then no limit.
435433
436434
Returns
437435
-------

‎databento/historical/api/timeseries.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def stream(
4141
dataset : Dataset or str
4242
The dataset name for the request.
4343
symbols : List[Union[str, int]] or str, optional
44-
The symbols for the request. If ``None`` then will be for ALL symbols.
44+
The symbols for the request. If ``None`` then will be for **all** symbols.
4545
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
4646
The data record schema for the request.
4747
start : pd.Timestamp or date or str or int, optional
@@ -55,8 +55,7 @@ def stream(
5555
stype_out : SType or str, default 'product_id'
5656
The output symbology type to resolve to.
5757
limit : int, optional
58-
The maximum number of records to return.
59-
If ``None`` is passed, then no limit.
58+
The maximum number of records to return. If ``None`` then no limit.
6059
path : str, optional
6160
The file path to write to on disk (if provided).
6261
@@ -137,7 +136,7 @@ async def stream_async(
137136
dataset : Dataset or str
138137
The dataset name for the request.
139138
symbols : List[Union[str, int]] or str, optional
140-
The symbols for the request. If ``None`` then will be for ALL symbols.
139+
The symbols for the request. If ``None`` then will be for **all** symbols.
141140
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades' # noqa
142141
The data record schema for the request.
143142
start : pd.Timestamp or date or str or int, optional
@@ -151,8 +150,7 @@ async def stream_async(
151150
stype_out : SType or str, default 'product_id'
152151
The output symbology type to resolve to.
153152
limit : int, optional
154-
The maximum number of records to return.
155-
If ``None`` is passed, then no limit.
153+
The maximum number of records to return. If ``None`` then no limit.
156154
path : str, optional
157155
The file path to write to on disk (if provided).
158156

0 commit comments

Comments
 (0)