improve docs

This commit is contained in:
Floris Bruynooghe
2023-02-20 13:10:29 +01:00
parent 4637a28bf6
commit 73b90eee3e

View File

@@ -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(())