Skip to content

Commit 69ab3b3

Browse files
committed
DOC: Update stype_out documentation
1 parent 392c622 commit 69ab3b3

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

databento/historical/api/batch.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ def submit_job(
135135
The input symbology type to resolve from.
136136
stype_out : SType or str, default 'instrument_id'
137137
The output symbology type to resolve to.
138+
Must be a valid symbology combination with `stype_in`.
139+
See `symbology combinations`. https://www.databento.com/standards-and-conventions/symbology#supported-symbology-combinations
138140
limit : int, optional
139141
The maximum number of records to return. If `None` then no limit.
140142

databento/historical/api/symbology.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ def resolve(
5050
The input symbology type to resolve from.
5151
stype_out : SType or str, default 'instrument_id'
5252
The output symbology type to resolve to.
53+
Must be a valid symbology combination with `stype_in`.
54+
See `symbology combinations`. https://www.databento.com/standards-and-conventions/symbology#supported-symbology-combinations
5355
start_date : date or str
5456
The inclusive UTC start date of the request range.
5557
end_date : date or str, optional

databento/historical/api/timeseries.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ def get_range(
8080
The input symbology type to resolve from.
8181
stype_out : SType or str, default 'instrument_id'
8282
The output symbology type to resolve to.
83+
Must be a valid symbology combination with `stype_in`.
84+
See `symbology combinations`. https://www.databento.com/standards-and-conventions/symbology#supported-symbology-combinations
8385
limit : int, optional
8486
The maximum number of records to return. If `None` then no limit.
8587
path : PathLike[str] or str, optional
@@ -178,6 +180,8 @@ async def get_range_async(
178180
The input symbology type to resolve from.
179181
stype_out : SType or str, default 'instrument_id'
180182
The output symbology type to resolve to.
183+
Must be a valid symbology combination with `stype_in`.
184+
See `symbology combinations`. https://www.databento.com/standards-and-conventions/symbology#supported-symbology-combinations
181185
limit : int, optional
182186
The maximum number of records to return. If `None` then no limit.
183187
path : PathLike[str] or str, optional

0 commit comments

Comments
 (0)