DOC: Update wording around request range

Author: robertmaierle

databento/historical/api/batch.py

@@ -96,12 +96,12 @@ def submit_job(
         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
             The data record schema for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start of the request time range (inclusive).
+            The inclusive start of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end of the request time range (exclusive).
+            The exclusive end of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.

databento/historical/api/metadata.py

@@ -67,10 +67,10 @@ def list_datasets(
         Parameters
         ----------
         start_date : date or str, optional
-            The start date (UTC) for the request range.
+            The inclusive UTC start date of the request range.
             If `None` then first date available.
         end_date : date or str, optional
-            The end date (UTC) for the request range.
+            The exclusive UTC end date of the request range.
             If `None` then last date available.
 
         Returns
@@ -202,10 +202,10 @@ def get_dataset_condition(
         dataset : Dataset or str
             The dataset code (string identifier) for the request.
         start_date : date or str, optional
-            The start date (UTC) for the request range.
+            The inclusive UTC start date of the request range.
             If `None` then first date available.
         end_date : date or str, optional
-            The end date (UTC) for the request range.
+            The inclusive UTC end date of the request range.
             If `None` then last date available.
 
         Returns
@@ -279,11 +279,11 @@ def get_record_count(
         dataset : Dataset or str
             The dataset code for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start datetime for the request range (inclusive).
+            The inclusive start of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end datetime for the request range (exclusive).
+            The exclusive end of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
             Defaults to the forward filled value of `start` based on the resolution provided.
@@ -347,11 +347,11 @@ def get_billable_size(
         dataset : Dataset or str
             The dataset code for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start datetime for the request range (inclusive).
+            The inclusive start of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end datetime for the request range (exclusive).
+            The exclusive end of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
             Defaults to the forward filled value of `start` based on the resolution provided.
@@ -417,11 +417,11 @@ def get_cost(
         dataset : Dataset or str
             The dataset code for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start datetime for the request range (inclusive).
+            The inclusive start of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end datetime for the request range (exclusive).
+            The exclusive end of the request range.
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
             Defaults to the forward filled value of `start` based on the resolution provided.

databento/historical/api/symbology.py

@@ -51,9 +51,10 @@ def resolve(
         stype_out : SType or str, default 'instrument_id'
             The output symbology type to resolve to.
         start_date : date or str
-            The start date (UTC) of the request time range (inclusive).
+            The inclusive UTC start date of the request range.
         end_date : date or str, optional
-            The end date (UTC) of the request time range (exclusive).
+            The exclusive UTC end date of the request range.
+            Defaults to the forward filled value of `start` based on the resolution provided.
 
         Returns
         -------

databento/historical/api/timeseries.py

@@ -60,12 +60,12 @@ def get_range(
         dataset : Dataset or str
             The dataset code (string identifier) for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start datetime of the request time range (inclusive).
+            The inclusive start of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end datetime of the request time range (exclusive).
+            The exclusive end of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
@@ -158,12 +158,12 @@ async def get_range_async(
         dataset : Dataset or str
             The dataset code (string identifier) for the request.
         start : pd.Timestamp, datetime, date, str, or int
-            The start of the request time range (inclusive).
+            The inclusive start of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
         end : pd.Timestamp, datetime, date, str, or int, optional
-            The end of the request time range (exclusive).
+            The exclusive end of the request range.
             Filters on `ts_recv` if it exists in the schema, otherwise `ts_event`.
             Assumes UTC as timezone unless passed a tz-aware object.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.