Skip to content

Commit 656c38b

Browse files
committed
DOC: Update forward fill docs
1 parent 17fb005 commit 656c38b

File tree

6 files changed

+9
-12
lines changed

6 files changed

+9
-12
lines changed

databento/historical/api/batch.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,7 @@ def submit_job(
102102
The end datetime of the request time range (exclusive).
103103
Assumes UTC as timezone unless passed a tz-aware object.
104104
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
105-
Values are forward filled based on the resolution provided.
106-
Defaults to the same value as `start`.
105+
Defaults to the forward filled value of `start` based on the resolution provided.
107106
encoding : Encoding or str {'dbn', 'csv', 'json'}, default 'dbn'
108107
The data encoding.
109108
compression : Compression or str {'none', 'zstd'}, default 'zstd'

databento/historical/api/metadata.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,7 @@ def get_record_count(
286286
The end datetime for the request range (exclusive).
287287
Assumes UTC as timezone unless otherwise specified.
288288
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
289-
Values are forward filled based on the resolution provided.
290-
Defaults to the same value as `start`.
289+
Defaults to the forward filled value of `start` based on the resolution provided.
291290
symbols : Iterable[str | int] or str or int, optional
292291
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
293292
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
@@ -355,8 +354,7 @@ def get_billable_size(
355354
The end datetime for the request range (exclusive).
356355
Assumes UTC as timezone unless otherwise specified.
357356
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
358-
Values are forward filled based on the resolution provided.
359-
Defaults to the same value as `start`.
357+
Defaults to the forward filled value of `start` based on the resolution provided.
360358
symbols : Iterable[str | int] or str, or int, optional
361359
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
362360
If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
@@ -425,8 +423,7 @@ def get_cost(
425423
The end datetime for the request range (exclusive).
426424
Assumes UTC as timezone unless otherwise specified.
427425
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
428-
Values are forward filled based on the resolution provided.
429-
Defaults to the same value as `start`.
426+
Defaults to the forward filled value of `start` based on the resolution provided.
430427
mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, default 'historical-streaming'
431428
The data feed mode for the request.
432429
symbols : Iterable[str | int] or str or int, optional

databento/historical/api/timeseries.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ def get_range(
6767
The end datetime of the request time range (exclusive).
6868
Assumes UTC as timezone unless passed a tz-aware object.
6969
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
70-
Values are forward filled based on the resolution provided.
71-
Defaults to the same value as `start`.
70+
Defaults to the forward filled value of `start` based on the resolution provided.
7271
symbols : Iterable[str | int], or str, or int, optional
7372
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
7473
If more than 1 symbol is specified, the data is merged and sorted by time.
@@ -164,8 +163,7 @@ async def get_range_async(
164163
The end datetime of the request time range (exclusive).
165164
Assumes UTC as timezone unless passed a tz-aware object.
166165
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
167-
Values are forward filled based on the resolution provided.
168-
Defaults to the same value as `start`.
166+
Defaults to the forward filled value of `start` based on the resolution provided.
169167
symbols : Iterable[str | int] or str or int, optional
170168
The instrument symbols to filter for. Takes up to 2,000 symbols per request.
171169
If more than 1 symbol is specified, the data is merged and sorted by time.

databento/reference/api/adjustment.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ def get_range(
5757
The end datetime of the request time range (exclusive) based on `ex_date`.
5858
Assumes UTC as timezone unless passed a tz-aware object.
5959
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
60+
Defaults to the forward filled value of `start` based on the resolution provided.
6061
symbols : Iterable[str] or str, optional
6162
The symbols to filter for. Takes up to 2,000 symbols per request.
6263
If more than 1 symbol is specified, the data is merged and sorted by time.

databento/reference/api/corporate.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ def get_range(
6161
The end datetime of the request time range (exclusive) based on `index`.
6262
Assumes UTC as timezone unless passed a tz-aware object.
6363
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
64+
Defaults to the forward filled value of `start` based on the resolution provided.
6465
index : str, default 'event_date'
6566
The index column used for filtering the `start` and `end` time range
6667
and for record ordering.

databento/reference/api/security.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ def get_range(
5858
The end datetime of the request time range (exclusive) based on `index`.
5959
Assumes UTC as timezone unless passed a tz-aware object.
6060
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
61+
Defaults to the forward filled value of `start` based on the resolution provided.
6162
index : str, default 'ts_effective'
6263
The index column used for filtering the `start` and `end` time range
6364
and for record ordering.

0 commit comments

Comments
 (0)