From 73b90eee3e6ba5243f4bad22d24ffddb197ebaae Mon Sep 17 00:00:00 2001 From: Floris Bruynooghe Date: Mon, 20 Feb 2023 13:10:29 +0100 Subject: [PATCH] improve docs --- src/imex/transfer.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/imex/transfer.rs b/src/imex/transfer.rs index 412b302a4..aa32ba3c4 100644 --- a/src/imex/transfer.rs +++ b/src/imex/transfer.rs @@ -247,8 +247,9 @@ impl BackupProvider { /// Awaits the [`BackupProvider`] until it is finished. /// - /// This waits until someone connected to the sender and transferred a backup. If the - /// [`BackupProvider`] task results in an error it will be returned here. + /// This waits until someone connected to the sender and finished transferring a backup. + /// A failed transfer also counts as a finished transfer. If the [`BackupProvider`] + /// task results in an error it will be returned here. pub async fn join(self) -> Result<()> { self.handle.await??; Ok(())