From d56e05a11a6bdaf0561e55ec025fc96e4fe24686 Mon Sep 17 00:00:00 2001 From: Floris Bruynooghe Date: Tue, 14 Feb 2023 13:27:15 +0100 Subject: [PATCH] fixup doc links --- src/blob.rs | 5 +++-- src/imex.rs | 2 +- src/imex/transfer.rs | 2 +- src/qr.rs | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/blob.rs b/src/blob.rs index f291fdde5..b6920f6ce 100644 --- a/src/blob.rs +++ b/src/blob.rs @@ -242,8 +242,9 @@ impl<'a> BlobObject<'a> { /// including the dot. E.g. "foo.txt" is returned as `("foo", /// ".txt")` while "bar" is returned as `("bar", "")`. /// - /// The extension part will always be lowercased. Note that [`imex::transfer`] relies - /// on this for safety, if uppercase extensions are ever allowed it needs to be adapted. + /// The extension part will always be lowercased. Note that [`crate::imex::get_backup`] + /// relies on this for safety, if uppercase extensions are ever allowed it needs to be + /// adapted. fn sanitise_name(name: &str) -> (String, String) { let mut name = name.to_string(); for part in name.rsplit('/') { diff --git a/src/imex.rs b/src/imex.rs index 34b4caa62..366092170 100644 --- a/src/imex.rs +++ b/src/imex.rs @@ -804,7 +804,7 @@ impl<'a> BlobDirContents<'a> { } } -/// A stream for [`Blob`]s. +/// A stream for [`BlobObject`]s. /// /// The stream emits [`EventType::ImexProgress`] events as it being consumed. /// diff --git a/src/imex/transfer.rs b/src/imex/transfer.rs index e0888eaa3..1f00d6dc4 100644 --- a/src/imex/transfer.rs +++ b/src/imex/transfer.rs @@ -398,7 +398,7 @@ async fn on_blob( /// Spawns a task proxying progress events. /// -/// This spawns a tokio tasks which receives events from the [`ProgressEmitter`] and sends +/// This spawns a tokio task which receives events from the [`ProgressEmitter`] and sends /// them to the context. The task finishes when the emitter is dropped. /// /// This could be done directly in the emitter by making it less generic. diff --git a/src/qr.rs b/src/qr.rs index a5567d92b..a59036eba 100644 --- a/src/qr.rs +++ b/src/qr.rs @@ -166,7 +166,7 @@ pub async fn check_qr(context: &Context, qr: &str) -> Result { /// This is the inverse of [`check_qr`] for that variant only. /// /// TODO: Refactor this so all variants have a correct [`Display`] and transform `check_qr` -/// into [`FromStr`]. +/// into `FromStr`. pub fn format_backup(qr: &Qr) -> Result { match qr { Qr::Backup { ref ticket } => Ok(format!("{DCBACKUP_SCHEME}{ticket}")),