fixup doc links

This commit is contained in:
Floris Bruynooghe
2023-02-14 13:27:15 +01:00
parent c379a4e5a7
commit d56e05a11a
4 changed files with 6 additions and 5 deletions

View File

@@ -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('/') {

View File

@@ -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.
///

View File

@@ -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.

View File

@@ -166,7 +166,7 @@ pub async fn check_qr(context: &Context, qr: &str) -> Result<Qr> {
/// 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<String> {
match qr {
Qr::Backup { ref ticket } => Ok(format!("{DCBACKUP_SCHEME}{ticket}")),