From 63782b8a47adfefb8a784459148a5f0c7265f12c Mon Sep 17 00:00:00 2001
From: Moshe Shababo <17073733+moshababo@users.noreply.github.com>
Date: Tue, 5 Dec 2023 22:00:48 -0600
Subject: [PATCH] Add docs

---
 node/actors/bft/src/testonly/ut_harness.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/node/actors/bft/src/testonly/ut_harness.rs b/node/actors/bft/src/testonly/ut_harness.rs
index d71f16d5..486a6787 100644
--- a/node/actors/bft/src/testonly/ut_harness.rs
+++ b/node/actors/bft/src/testonly/ut_harness.rs
@@ -81,6 +81,15 @@ impl UTHarness {
             .unwrap();
     }
 
+    /// Validate protocol liveness in the aftermath of a timeout.
+    ///
+    /// Params refer to the expected values in the next produced `ReplicaPrepare`
+    /// messages for the new iteration.
+    ///
+    /// * `view` - the expected view of the next `ReplicaPrepare`.
+    /// * `high_vote_view` - the expected view of the high vote of the next `ReplicaPrepare`.
+    /// * `high_qc_view` - the expected view of the high qc of the next `ReplicaPrepare`.
+    ///
     pub(crate) async fn check_recovery_after_timeout(
         &mut self,
         view: ViewNumber,