about summary refs log tree commit diff
path: root/tvix/nix-compat
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-03-15T21·22+0200
committerclbot <clbot@tvl.fyi>2024-03-15T23·16+0000
commit56dc4f735b58e38598a520451d4c95979745b9ad (patch)
tree28fa029e7080ab14e99e998becdcd10754d08bbc /tvix/nix-compat
parentd3534ee051abad5117e9578854b6cd13a14d940d (diff)
docs(tvix): fix some docstrings r/7700
Change-Id: Ife599387d0472cd746b992bd6755a2fb6a0e0dc4
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11158
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: Connor Brewster <cbrewster@hey.com>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/nix-compat')
-rw-r--r--tvix/nix-compat/src/wire/bytes.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/tvix/nix-compat/src/wire/bytes.rs b/tvix/nix-compat/src/wire/bytes.rs
index c720f912eee2..f2fe30083b1c 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<u8>
+/// Internally takes care of dealing with the padding, so the returned `Vec<u8>`
 /// 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<u8> only contains the payload.
+/// so the returned `Vec<u8>` only contains the payload.
 pub async fn read_bytes_unchecked<R: AsyncReadExt + Unpin>(r: &mut R) -> std::io::Result<Vec<u8>> {
     read_bytes(r, 0u64..).await
 }