From e32fa43a53dcc534828722ff1a980c24be336a5f Mon Sep 17 00:00:00 2001
From: "Carol (Nichols || Goulding)" <carol.nichols@integer32.com>
Date: Wed, 5 May 2021 10:48:41 -0400
Subject: [PATCH] docs: Add note about implication of write buffer errors

---
 server/src/db.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/server/src/db.rs b/server/src/db.rs
index d0a22fb72f..1584e37cad 100644
--- a/server/src/db.rs
+++ b/server/src/db.rs
@@ -1098,6 +1098,10 @@ impl Db {
     ///   will replicate the `SequencedEntry` based on the configured rules.
     /// - If the mutable buffer is configured, the `SequencedEntry` is then written into the
     ///   mutable buffer.
+    ///
+    /// Note that if the write buffer is configured but there is an error storing the
+    /// `SequencedEntry` in the write buffer, the `SequencedEntry` will *not* reach the mutable
+    /// buffer.
     pub fn store_sequenced_entry(&self, sequenced_entry: Arc<dyn SequencedEntry>) -> Result<()> {
         // Send to the write buffer, if configured
         if let Some(wb) = &self.write_buffer {