From 3e065b857387d32d57a9dbabe680c9eb94ab4d05 Mon Sep 17 00:00:00 2001
From: Sebastian Holmin <sebastian.holmin@mullvad.net>
Date: Thu, 9 Jan 2025 14:55:57 +0100
Subject: [PATCH] Add panic note to docstring

---
 talpid-tunnel-config-client/src/classic_mceliece.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/talpid-tunnel-config-client/src/classic_mceliece.rs b/talpid-tunnel-config-client/src/classic_mceliece.rs
index 93de357cdd00..fbe69149cf04 100644
--- a/talpid-tunnel-config-client/src/classic_mceliece.rs
+++ b/talpid-tunnel-config-client/src/classic_mceliece.rs
@@ -26,6 +26,10 @@ static KEYPAIR_RX: OnceLock<Mutex<mpsc::Receiver<KeyPair>>> = OnceLock::new();
 ///
 /// It can take upwards of 200 ms to generate McEliece key pairs so it needs to be done before we
 /// start connecting to the tunnel.
+///
+/// # Panic
+///
+/// Panics if the buffer capacity is 0.
 pub fn spawn_keypair_worker(bufsize: usize) -> mpsc::Receiver<KeyPair> {
     let (tx, rx) = mpsc::channel(bufsize);