DOC: Standardize flags field description

databento · Apr 19, 2024 · 304bea5 · 304bea5
1 parent e523041
commit 304bea5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/python/python/databento_dbn/_lib.pyi b/python/python/databento_dbn/_lib.pyi
@@ -1202,7 +1202,7 @@ class _MBOBase:
     @property
     def flags(self) -> int:
         """
-        A combination of packet end with matching engine status.
+        A bit field indicating event end, message characteristics, and data quality.
 
         Returns
         -------
@@ -1616,7 +1616,7 @@ class _MBPBase:
     @property
     def flags(self) -> int:
         """
-        A combination of packet end with matching engine status.
+        A bit field indicating event end, message characteristics, and data quality.
 
         Returns
         -------
@@ -1782,7 +1782,7 @@ class CbboMsg(Record):
     @property
     def flags(self) -> int:
         """
-        A combination of packet end with matching engine status.
+        A bit field indicating event end, message characteristics, and data quality.
 
         Returns
         -------

diff --git a/rust/dbn/src/record.rs b/rust/dbn/src/record.rs
@@ -91,7 +91,7 @@ pub struct MboMsg {
     #[dbn(encode_order(5))]
     #[pyo3(get)]
     pub size: u32,
-    /// A combination of packet end with matching engine status. See
+    /// A bit field indicating event end, message characteristics, and data quality. See
     /// [`enums::flags`](crate::enums::flags) for possible values.
     #[dbn(fmt_binary)]
     #[pyo3(get)]
@@ -224,7 +224,7 @@ pub struct TradeMsg {
     /// specified by the original source.
     #[dbn(c_char, encode_order(3))]
     pub side: c_char,
-    /// A combination of packet end with matching engine status. See
+    /// A bit field indicating event end, message characteristics, and data quality. See
     /// [`enums::flags`](crate::enums::flags) for possible values.
     #[dbn(fmt_binary)]
     #[pyo3(get)]
@@ -281,7 +281,7 @@ pub struct Mbp1Msg {
     /// **N**one where no side is specified by the original source.
     #[dbn(c_char, encode_order(3))]
     pub side: c_char,
-    /// A combination of packet end with matching engine status. See
+    /// A bit field indicating event end, message characteristics, and data quality. See
     /// [`enums::flags`](crate::enums::flags) for possible values.
     #[dbn(fmt_binary)]
     #[pyo3(get)]
@@ -341,7 +341,7 @@ pub struct Mbp10Msg {
     /// **N**one where no side is specified by the original source.
     #[dbn(c_char, encode_order(3))]
     pub side: c_char,
-    /// A combination of packet end with matching engine status. See
+    /// A bit field indicating event end, message characteristics, and data quality. See
     /// [`enums::flags`](crate::enums::flags) for possible values.
     #[dbn(fmt_binary)]
     #[pyo3(get)]
@@ -401,7 +401,7 @@ pub struct CbboMsg {
     /// **N**one where no side is specified by the original source.
     #[dbn(c_char, encode_order(3))]
     pub side: c_char,
-    /// A combination of packet end with matching engine status. See
+    /// A bit field indicating event end, message characteristics, and data quality. See
     /// [`enums::flags`](crate::enums::flags) for possible values.
     #[dbn(fmt_binary)]
     #[pyo3(get)]