about summary refs log tree commit diff
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
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
-rw-r--r--tvix/build/src/proto/grpc_buildservice_wrapper.rs2
-rw-r--r--tvix/eval/src/io.rs2
-rw-r--r--tvix/nix-compat/src/wire/bytes.rs4
-rw-r--r--tvix/store/src/import.rs2
4 files changed, 5 insertions, 5 deletions
diff --git a/tvix/build/src/proto/grpc_buildservice_wrapper.rs b/tvix/build/src/proto/grpc_buildservice_wrapper.rs
index 4c176e3cf4fb..024f075de9ad 100644
--- a/tvix/build/src/proto/grpc_buildservice_wrapper.rs
+++ b/tvix/build/src/proto/grpc_buildservice_wrapper.rs
@@ -4,7 +4,7 @@ use tonic::async_trait;
 
 use super::{Build, BuildRequest};
 
-/// Implements the gRPC server trait ([self::build_service_server::BuildService]
+/// Implements the gRPC server trait ([crate::proto::build_service_server::BuildService]
 /// for anything implementing [BuildService].
 pub struct GRPCBuildServiceWrapper<BUILD> {
     inner: BUILD,
diff --git a/tvix/eval/src/io.rs b/tvix/eval/src/io.rs
index 6589c0dc5cae..1c38bc68de90 100644
--- a/tvix/eval/src/io.rs
+++ b/tvix/eval/src/io.rs
@@ -48,7 +48,7 @@ pub trait EvalIO {
     /// * `builtins.pathExists :: path -> bool`
     fn path_exists(&self, path: &Path) -> io::Result<bool>;
 
-    /// Read the file at the specified path to a Vec<u8>.
+    /// Read the file at the specified path to a `Vec<u8>`.
     ///
     /// This is used for the following language evaluation cases:
     ///
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
 }
diff --git a/tvix/store/src/import.rs b/tvix/store/src/import.rs
index 588a0108931e..50c6b73109d7 100644
--- a/tvix/store/src/import.rs
+++ b/tvix/store/src/import.rs
@@ -84,7 +84,7 @@ pub fn derive_nar_ca_path_info(nar_size: u64, nar_sha256: [u8; 32], root_node: N
     }
 }
 
-/// Ingest the given path [`path`] and register the resulting output path in the
+/// Ingest the given path `path` and register the resulting output path in the
 /// [`PathInfoService`] as a recursive fixed output NAR.
 #[instrument(skip_all, fields(store_name=name, path=?path), err)]
 pub async fn import_path_as_nar_ca<BS, DS, PS, P>(