clarify successor increment in sequence id

pola-rs · Jun 24, 2024 · c30937a · c30937a
1 parent 0d612cc
commit c30937a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/polars-stream/src/morsel.rs b/crates/polars-stream/src/morsel.rs
@@ -26,6 +26,8 @@ impl MorselSeq {
 
     // The morsel sequence id which comes after this morsel.
     pub fn successor(self) -> Self {
+        // We increment by two because in the future we want to use the least
+        // significant bit to indicate the final morsel with that sequence id.
         Self(self.0.checked_add(2).unwrap())
     }