Clarify documentation

Co-authored-by: Arya <[email protected]>
ZcashFoundation · Nov 14, 2023 · 21b5c39 · 21b5c39
1 parent 6bdf6c1
commit 21b5c39
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/zebra-chain/src/diagnostic/task/thread.rs b/zebra-chain/src/diagnostic/task/thread.rs
@@ -18,9 +18,11 @@ where
 {
     type Output = T;
 
-    /// Panics if the thread panicked.
-    /// If `panic_on_unexpected_termination` is true, and Zebra is not shutting down, also panics
-    /// if the thread exits.
+    /// # Panics
+    ///
+    /// - if the thread panicked.
+    /// - if the thread is cancelled, `panic_on_unexpected_termination` is true, and
+    ///   Zebra is not shutting down.
     ///
     /// Threads can't be cancelled except by using a panic, so there are no thread errors here.
     /// `panic_on_unexpected_termination` is

diff --git a/zebra-network/src/peer/client.rs b/zebra-network/src/peer/client.rs
@@ -441,6 +441,8 @@ impl Client {
 
         let result = match self.heartbeat_task.poll_unpin(cx) {
             Poll::Pending => {
+                // The heartbeat task returns `Pending` while it continues to run.
+                // But if it has dropped its receiver, it is shutting down, and we should also shut down.
                 if is_canceled {
                     self.set_task_exited_error(
                         "heartbeat",