maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix): fix some docstrings

Browse source 
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
This commit is contained in:
Florian Klink 2024-03-15 23:22:11 +02:00 • committed by clbot
parent d3534ee051
commit 56dc4f735b
4 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
tvix/build/src/proto/grpc_buildservice_wrapper.rs
View file

@ -4,7 +4,7 @@ use tonic::async_trait;
use super::{Build, BuildRequest}; 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]. /// for anything implementing [BuildService].
pub struct GRPCBuildServiceWrapper<BUILD> { pub struct GRPCBuildServiceWrapper<BUILD> {
inner: BUILD, inner: BUILD,

2
tvix/eval/src/io.rs
View file

@ -48,7 +48,7 @@ pub trait EvalIO {
/// * `builtins.pathExists :: path -> bool` /// * `builtins.pathExists :: path -> bool`
fn path_exists(&self, path: &Path) -> io::Result<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: /// This is used for the following language evaluation cases:
/// ///

4
tvix/nix-compat/src/wire/bytes.rs
View file

@ -7,7 +7,7 @@ use super::primitive;
#[allow(dead_code)] #[allow(dead_code)]
/// Read a limited number of bytes from the AsyncRead. /// Read a limited number of bytes from the AsyncRead.
/// Rejects reading more than `allowed_size` bytes of payload. /// 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. /// only contains the payload.
/// This always buffers the entire contents into memory, we'll add a streaming /// This always buffers the entire contents into memory, we'll add a streaming
/// version later. /// version later.
@ -67,7 +67,7 @@ where
/// Read an unlimited number of bytes from the AsyncRead. /// Read an unlimited number of bytes from the AsyncRead.
/// Note this can exhaust memory. /// Note this can exhaust memory.
/// Internally uses [read_bytes], which takes care of dealing with the padding, /// 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>> { pub async fn read_bytes_unchecked<R: AsyncReadExt + Unpin>(r: &mut R) -> std::io::Result<Vec<u8>> {
read_bytes(r, 0u64..).await read_bytes(r, 0u64..).await
} }

2
tvix/store/src/import.rs
View file

@ -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. /// [`PathInfoService`] as a recursive fixed output NAR.
#[instrument(skip_all, fields(store_name=name, path=?path), err)] #[instrument(skip_all, fields(store_name=name, path=?path), err)]
pub async fn import_path_as_nar_ca<BS, DS, PS, P>( pub async fn import_path_as_nar_ca<BS, DS, PS, P>(