From 65715bc096b1e977ccf1964d4b4649a97b056bc1 Mon Sep 17 00:00:00 2001
From: Wolfgang Bumiller <w.bumiller@proxmox.com>
Date: Tue, 30 Jul 2024 16:16:16 +0200
Subject: [PATCH] io, serde, schema: doc fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
---
 proxmox-io/src/std_channel_writer.rs | 3 ++-
 proxmox-schema/src/de/verify.rs      | 2 +-
 proxmox-serde/src/lib.rs             | 2 +-
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/proxmox-io/src/std_channel_writer.rs b/proxmox-io/src/std_channel_writer.rs
index 72347531..3ffe0097 100644
--- a/proxmox-io/src/std_channel_writer.rs
+++ b/proxmox-io/src/std_channel_writer.rs
@@ -4,7 +4,8 @@ use std::sync::mpsc::SyncSender;
 
 /// Wrapper around SyncSender, which implements Write
 ///
-/// Each write in translated into a send(Vec<u8>).
+/// Each write in translated into a `send(Vec<u8>)` (that is, for each write, an owned byte vector
+/// is allocated and sent over the channel).
 pub struct StdChannelWriter<E>(SyncSender<Result<Vec<u8>, E>>);
 
 impl<E: ToString> StdChannelWriter<E> {
diff --git a/proxmox-schema/src/de/verify.rs b/proxmox-schema/src/de/verify.rs
index 615e69cf..67a8c9e8 100644
--- a/proxmox-schema/src/de/verify.rs
+++ b/proxmox-schema/src/de/verify.rs
@@ -99,7 +99,7 @@ fn push_err_do(path: String, err: anyhow::Error) {
 
 /// Helper to collect multiple deserialization errors for better reporting.
 ///
-/// This is similar to [`IgnoredAny`] in that it implements [`Deserialize`]
+/// This is similar to [`IgnoredAny`](serde::de::IgnoredAny) in that it implements [`Deserialize`]
 /// but does not actually deserialize to anything, however, when a deserialization error occurs,
 /// it'll try to continue and collect further errors.
 ///
diff --git a/proxmox-serde/src/lib.rs b/proxmox-serde/src/lib.rs
index dfd0915e..88986698 100644
--- a/proxmox-serde/src/lib.rs
+++ b/proxmox-serde/src/lib.rs
@@ -180,7 +180,7 @@ pub mod string_as_base64 {
     }
 }
 
-/// Serialize Vec<u8> as base64url encoded string without padding.
+/// Serialize `Vec<u8>` as base64url encoded string without padding.
 ///
 /// Usage example:
 /// ```