DOC: Document how Live start is implemented

databento · Feb 13, 2024 · 3ce1294 · 3ce1294
1 parent d60e671
commit 3ce1294
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,9 @@
 
 #### Enhancements
 - Document cancellation safety of `LiveClient` methods (credit: @yongqli)
+- Document `live::Subscription::start` is based on `ts_event`
 
-### Breaking changes
+#### Breaking changes
 - Changed default `upgrade_policy` in `LiveBuilder` and `GetRangeParams` to `Upgrade` so
   by default the primary record types can always be used
 

diff --git a/src/live.rs b/src/live.rs
@@ -317,8 +317,8 @@ pub struct Subscription {
     /// The symbology type of the symbols in [`symbols`](Self::symbols).
     #[builder(default = SType::RawSymbol)]
     pub stype_in: SType,
-    /// If specified, requests available data since that time. When `None`,
-    /// only real-time data is sent.
+    /// If specified, requests available data since that time (inclusive), based on
+    /// [`ts_event`](dbn::RecordHeader::ts_event). When `None`, only real-time data is sent.
     ///
     /// Setting this field is not supported once the session has been started with
     /// [`LiveClient::start`](crate::LiveClient::start).