Skip to content

Commit eca7e9d

Browse files
cjdsellerscjdsellers
committed
DOC: Standardize all symbols filtering language
1 parent c16784d commit eca7e9d

6 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎databento/historical/api/batch.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def submit_job(
9292
symbols : Iterable[str | int] or str or int
9393
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
9494
If more than 1 symbol is specified, the data is merged and sorted by time.
95-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
95+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
9696
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
9797
The data record schema for the request.
9898
start : pd.Timestamp or date or str or int

‎databento/historical/api/metadata.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ def get_record_count(
288288
Defaults to the same value as `start`.
289289
symbols : Iterable[str | int] or str or int, optional
290290
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
291-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
291+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
292292
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
293293
The data record schema for the request.
294294
stype_in : SType or str, default 'raw_symbol'
@@ -357,7 +357,7 @@ def get_billable_size(
357357
Defaults to the same value as `start`.
358358
symbols : Iterable[str | int] or str or int, optional
359359
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
360-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
360+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
361361
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
362362
The data record schema for the request.
363363
stype_in : SType or str, default 'raw_symbol'
@@ -429,7 +429,7 @@ def get_cost(
429429
The data feed mode for the request.
430430
symbols : Iterable[str | int] or str or int, optional
431431
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
432-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
432+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
433433
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
434434
The data record schema for the request.
435435
stype_in : SType or str, default 'raw_symbol'

‎databento/historical/api/timeseries.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def get_range(
7171
symbols : Iterable[str | int], or str, or int, optional
7272
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
7373
If more than 1 symbol is specified, the data is merged and sorted by time.
74-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
74+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
7575
schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, default 'trades'
7676
The data record schema for the request.
7777
stype_in : SType or str, default 'raw_symbol'
@@ -168,7 +168,7 @@ async def get_range_async(
168168
symbols : Iterable[str | int] or str or int, optional
169169
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
170170
If more than 1 symbol is specified, the data is merged and sorted by time.
171-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
171+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
172172
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
173173
The data record schema for the request.
174174
stype_in : SType or str, default 'raw_symbol'

‎databento/reference/api/adjustment.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def get_range(
5959
symbols : Iterable[str] or str, optional
6060
The symbols to filter for. Takes up to 2,000 symbols per request.
6161
If more than 1 symbol is specified, the data is merged and sorted by time.
62-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
62+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
6363
stype_in : SType or str, default 'raw_symbol'
6464
The input symbology type to resolve from.
6565
Use any of 'raw_symbol', 'nasdaq_symbol', 'isin', 'us_code'.

‎databento/reference/api/corporate.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def get_range(
6767
symbols : Iterable[str] or str, optional
6868
The symbols to filter for. Takes up to 2,000 symbols per request.
6969
If more than 1 symbol is specified, the data is merged and sorted by time.
70-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
70+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
7171
stype_in : SType or str, default 'raw_symbol'
7272
The input symbology type to resolve from.
7373
Use any of 'raw_symbol', 'nasdaq_symbol', 'isin', 'us_code',

‎databento/reference/api/security.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ def get_range(
6464
symbols : Iterable[str] or str, optional
6565
The symbols to filter for. Takes up to 2,000 symbols per request.
6666
If more than 1 symbol is specified, the data is merged and sorted by time.
67-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
67+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
6868
stype_in : SType or str, default 'raw_symbol'
6969
The input symbology type to resolve from.
7070
Use any of 'raw_symbol', 'nasdaq_symbol', 'isin', 'us_code',
@@ -138,7 +138,7 @@ def get_last(
138138
symbols : Iterable[str] or str, optional
139139
The symbols to filter for. Takes up to 2,000 symbols per request.
140140
If more than 1 symbol is specified, the data is merged and sorted by time.
141-
If 'ALL_SYMBOLS' or `None` then will be for **all** symbols.
141+
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
142142
stype_in : SType or str, default 'raw_symbol'
143143
The input symbology type to resolve from.
144144
Use any of 'raw_symbol', 'nasdaq_symbol', 'isin', 'us_code',

0 commit comments

Comments
 (0)