DOC: Standardize API reference pt4

Author: cjdsellers

databento/historical/api/batch.py

@@ -63,11 +63,11 @@ def timeseries_submit(
         start : pd.Timestamp or date or str or int, optional
             The start datetime of the request time range (inclusive).
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime of the request time range (exclusive).
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         encoding : Encoding or str {'dbz', 'csv', 'json'}, default 'dbz'
             The data encoding.
         compression : Compression or str {'none', 'zstd'}, default 'zstd'
@@ -86,7 +86,7 @@ def timeseries_submit(
             The output symbology type to resolve to.
         limit : int, optional
             The maximum number of records for the request.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
 
         Returns
         -------

databento/historical/api/metadata.py

@@ -272,18 +272,18 @@ def get_shape(
         start : pd.Timestamp or date or str or int, optional
             The start datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         encoding : Encoding or str {'dbz', 'csv', 'json'}, optional
             The data encoding.
         stype_in : SType or str, default 'native'
             The input symbology type to resolve from.
         limit : int, optional
             The maximum number of records to include in the query.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
 
         Returns
         -------
@@ -351,16 +351,16 @@ def get_billable_size(
         start : pd.Timestamp or date or str or int, optional
             The start datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         stype_in : SType or str, default 'native'
             The input symbology type to resolve from.
         limit : int, optional
             The maximum number of records to include in the query.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
 
         Returns
         -------
@@ -422,16 +422,16 @@ def get_cost(
         start : pd.Timestamp or date or str or int, optional
             The start datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime for the request range.
             Assumes UTC as timezone unless passed a tz-aware object.
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         stype_in : SType or str, default 'native'
             The input symbology type to resolve from.
         limit : int, optional
             The maximum number of records to include in the query.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
 
         Returns
         -------

databento/historical/api/timeseries.py

@@ -51,17 +51,17 @@ def stream(
             The data record schema for the request.
         start : pd.Timestamp or date or str or int, optional
             The start datetime (UTC) of the request time range (inclusive).
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime (UTC) of the request time range (exclusive).
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         stype_in : SType or str, default 'native'
             The input symbology type to resolve from.
         stype_out : SType or str, default 'product_id'
             The output symbology type to resolve to.
         limit : int, optional
             The maximum number of records to return.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
         path : str, optional
             The file path to write to on disk (if provided).
 
@@ -148,17 +148,17 @@ async def stream_async(
             The data record schema for the request.
         start : pd.Timestamp or date or str or int, optional
             The start datetime (UTC) of the request time range (inclusive).
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         end : pd.Timestamp or date or str or int, optional
             The end datetime (UTC) of the request time range (exclusive).
-            If using an integer then this represents nanoseconds since UNIX epoch.
+            If an integer is passed, then this represents nanoseconds since UNIX epoch.
         stype_in : SType or str, default 'native'
             The input symbology type to resolve from.
         stype_out : SType or str, default 'product_id'
             The output symbology type to resolve to.
         limit : int, optional
             The maximum number of records to return.
-            If ``None`` is passed then no limit.
+            If ``None`` is passed, then no limit.
         path : str, optional
             The file path to write to on disk (if provided).