From 56dc4f735b58e38598a520451d4c95979745b9ad Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Fri, 15 Mar 2024 23:22:11 +0200 Subject: docs(tvix): fix some docstrings Change-Id: Ife599387d0472cd746b992bd6755a2fb6a0e0dc4 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11158 Autosubmit: flokli Reviewed-by: Connor Brewster Tested-by: BuildkiteCI --- tvix/nix-compat/src/wire/bytes.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'tvix/nix-compat/src/wire/bytes.rs') diff --git a/tvix/nix-compat/src/wire/bytes.rs b/tvix/nix-compat/src/wire/bytes.rs index c720f912ee..f2fe30083b 100644 --- a/tvix/nix-compat/src/wire/bytes.rs +++ b/tvix/nix-compat/src/wire/bytes.rs @@ -7,7 +7,7 @@ use super::primitive; #[allow(dead_code)] /// Read a limited number of bytes from the AsyncRead. /// Rejects reading more than `allowed_size` bytes of payload. -/// Internally takes care of dealing with the padding, so the returned Vec +/// Internally takes care of dealing with the padding, so the returned `Vec` /// only contains the payload. /// This always buffers the entire contents into memory, we'll add a streaming /// version later. @@ -67,7 +67,7 @@ where /// Read an unlimited number of bytes from the AsyncRead. /// Note this can exhaust memory. /// Internally uses [read_bytes], which takes care of dealing with the padding, -/// so the returned Vec only contains the payload. +/// so the returned `Vec` only contains the payload. pub async fn read_bytes_unchecked(r: &mut R) -> std::io::Result> { read_bytes(r, 0u64..).await } -- cgit 1.4.1