From 3baddea84a59d1fc83b46f6934ffc7cd889e951d Mon Sep 17 00:00:00 2001
From: Jeb Bearer <jeb@espressosys.com>
Date: Mon, 12 Aug 2024 09:14:23 -0700
Subject: [PATCH] Document restart function

---
 sequencer/src/context.rs       | 1 +
 sequencer/src/restart_tests.rs | 5 +++++
 2 files changed, 6 insertions(+)

diff --git a/sequencer/src/context.rs b/sequencer/src/context.rs
index c32b9821e7..9492a0319f 100644
--- a/sequencer/src/context.rs
+++ b/sequencer/src/context.rs
@@ -346,6 +346,7 @@ impl<N: ConnectedNetwork<PubKey>, P: SequencerPersistence, Ver: StaticVersionTyp
     }
 }
 
+#[allow(clippy::too_many_arguments)]
 async fn handle_events<Ver: StaticVersionType>(
     node_id: u64,
     mut events: impl Stream<Item = Event<SeqTypes>> + Unpin,
diff --git a/sequencer/src/restart_tests.rs b/sequencer/src/restart_tests.rs
index 0dd0d6b9ef..c2bcfe2d14 100644
--- a/sequencer/src/restart_tests.rs
+++ b/sequencer/src/restart_tests.rs
@@ -506,6 +506,11 @@ impl TestNetwork {
         .unwrap();
     }
 
+    /// Restart indicated number of DA and non-DA nodes.
+    ///
+    /// If possible (less than a quorum of nodes have been stopped), check that remaining nodes can
+    /// still make progress without the restarted nodes. In any case, check that the network as a
+    /// whole makes progress once the restarted nodes are back online.
     async fn restart(&mut self, da_nodes: usize, regular_nodes: usize) {
         tracing::info!(da_nodes, regular_nodes, "shutting down some nodes");
         join_all(