Skip to content

Commit 3edf72f

Browse files
committed
DOC: Update intraday replay docs
1 parent 5dba39c commit 3edf72f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/live.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,12 @@ pub struct Subscription {
2626
/// The symbology type of the symbols in [`symbols`](Self::symbols).
2727
#[builder(default = SType::RawSymbol)]
2828
pub stype_in: SType,
29-
/// If specified, requests available data since that time (inclusive), based on
30-
/// [`ts_event`](dbn::RecordHeader::ts_event). When `None`, only real-time data is sent.
29+
/// The inclusive start of subscription replay.
30+
/// Pass [`OffsetDateTime::UNIX_EPOCH`](time::OffsetDateTime::UNIX_EPOCH) to request all available data.
31+
/// When `None`, only real-time data is sent.
3132
///
32-
/// Setting this field is not supported once the session has been started with
33-
/// [`LiveClient::start`](crate::LiveClient::start).
33+
/// Cannot be specified after the session is started with [`LiveClient::start`](crate::LiveClient::start).
34+
/// See [`Intraday Replay`](https://databento.com/docs/api-reference-live/basics/intraday-replay).
3435
#[builder(default, setter(strip_option))]
3536
pub start: Option<OffsetDateTime>,
3637
#[doc(hidden)]

0 commit comments

Comments
 (0)