Skip to content

Commit 8f0a03c

Browse files
committed
DOC: Standardize API reference pt7
1 parent e10b1e6 commit 8f0a03c

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

databento/historical/api/metadata.py

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,10 @@ def get_shape(
270270
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
271271
The data record schema for the request.
272272
start : pd.Timestamp or date or str or int, optional
273-
The start datetime for the request range.
274-
Assumes UTC as timezone unless passed a tz-aware object.
273+
The start datetime for the request range. Assumes UTC as timezone unless otherwise specified.
275274
If an integer is passed, then this represents nanoseconds since UNIX epoch.
276275
end : pd.Timestamp or date or str or int, optional
277-
The end datetime for the request range.
278-
Assumes UTC as timezone unless passed a tz-aware object.
276+
The end datetime for the request range. Assumes UTC as timezone unless otherwise specified.
279277
If an integer is passed, then this represents nanoseconds since UNIX epoch.
280278
encoding : Encoding or str {'dbz', 'csv', 'json'}, optional
281279
The data encoding.
@@ -348,12 +346,10 @@ def get_billable_size(
348346
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
349347
The data record schema for the request.
350348
start : pd.Timestamp or date or str or int, optional
351-
The start datetime for the request range.
352-
Assumes UTC as timezone unless passed a tz-aware object.
349+
The start datetime for the request range. Assumes UTC as timezone unless otherwise specified.
353350
If an integer is passed, then this represents nanoseconds since UNIX epoch.
354351
end : pd.Timestamp or date or str or int, optional
355-
The end datetime for the request range.
356-
Assumes UTC as timezone unless passed a tz-aware object.
352+
The end datetime for the request range. Assumes UTC as timezone unless otherwise specified.
357353
If an integer is passed, then this represents nanoseconds since UNIX epoch.
358354
stype_in : SType or str, default 'native'
359355
The input symbology type to resolve from.
@@ -418,12 +414,10 @@ def get_cost(
418414
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
419415
The data record schema for the request.
420416
start : pd.Timestamp or date or str or int, optional
421-
The start datetime for the request range.
422-
Assumes UTC as timezone unless passed a tz-aware object.
417+
The start datetime for the request range. Assumes UTC as timezone unless otherwise specified.
423418
If an integer is passed, then this represents nanoseconds since UNIX epoch.
424419
end : pd.Timestamp or date or str or int, optional
425-
The end datetime for the request range.
426-
Assumes UTC as timezone unless passed a tz-aware object.
420+
The end datetime for the request range. Assumes UTC as timezone unless otherwise specified.
427421
If an integer is passed, then this represents nanoseconds since UNIX epoch.
428422
stype_in : SType or str, default 'native'
429423
The input symbology type to resolve from.

0 commit comments

Comments
 (0)