Document connect_and_wait

mullvad · Oct 11, 2023 · 42cd82a · 42cd82a
1 parent 9962a56
commit 42cd82a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/test/test-manager/src/tests/helpers.rs b/test/test-manager/src/tests/helpers.rs
@@ -129,6 +129,10 @@ pub async fn ping_with_timeout(
         .map_err(Error::Rpc)
 }
 
+/// Try to connect to a Mullvad Tunnel.
+///
+/// If that fails for whatever reason, the Mullvad daemon ends up in the
+/// [`TunnelState::Error`] state & [`Error::DaemonError`] is returned.
 pub async fn connect_and_wait(mullvad_client: &mut ManagementServiceClient) -> Result<(), Error> {
     log::info!("Connecting");