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/build/src/proto/grpc_buildservice_wrapper.rs | 2 +- tvix/eval/src/io.rs | 2 +- tvix/nix-compat/src/wire/bytes.rs | 4 ++-- tvix/store/src/import.rs | 2 +- 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 4c176e3cf4..024f075de9 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 { inner: BUILD, diff --git a/tvix/eval/src/io.rs b/tvix/eval/src/io.rs index 6589c0dc5c..1c38bc68de 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; - /// Read the file at the specified path to a Vec. + /// Read the file at the specified path to a `Vec`. /// /// 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 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 } diff --git a/tvix/store/src/import.rs b/tvix/store/src/import.rs index 588a010893..50c6b73109 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( -- cgit 1.4.1