From 7fa53d22295763141b450903361200aa04ce662c Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Thu, 13 Mar 2025 07:22:45 +0100 Subject: [PATCH] docs(tvix/store): fix docstrings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I8fd2d6db3ac260bf7265fe15cb5bc010b8911dbf Reviewed-on: https://cl.tvl.fyi/c/depot/+/13251 Tested-by: BuildkiteCI Autosubmit: flokli Reviewed-by: Domen Kožar --- tvix/store/src/pathinfoservice/from_addr.rs | 4 ++-- tvix/store/src/utils.rs | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/tvix/store/src/pathinfoservice/from_addr.rs b/tvix/store/src/pathinfoservice/from_addr.rs index 0e8cc064d..9115ca96e 100644 --- a/tvix/store/src/pathinfoservice/from_addr.rs +++ b/tvix/store/src/pathinfoservice/from_addr.rs @@ -28,8 +28,8 @@ use url::Url; /// - `grpc+http://host:port`, `grpc+https://host:port` /// Connects to a (remote) tvix-store gRPC service. /// -/// As the [PathInfoService] needs to talk to [BlobService] and [DirectoryService], -/// these also need to be passed in. +/// As the [PathInfoService] needs to talk to [tvix_castore::blobservice::BlobService] and +/// [tvix_castore::directoryservice::DirectoryService], these also need to be passed in. pub async fn from_addr( uri: &str, context: Option<&CompositionContext<'_>>, diff --git a/tvix/store/src/utils.rs b/tvix/store/src/utils.rs index 6992da253..7e40340f6 100644 --- a/tvix/store/src/utils.rs +++ b/tvix/store/src/utils.rs @@ -31,7 +31,7 @@ pub struct CompositionConfigs { >, } -/// Provides a set clap arguments to configure tvix-[ca]store services. +/// Provides a set of clap arguments to configure tvix-\[ca\]store services. /// /// This particular variant has defaults tailored for usecases accessing data /// directly locally, like the `tvix-store daemon` command. @@ -52,7 +52,7 @@ pub struct ServiceUrls { experimental_store_composition: Option, } -/// Provides a set clap arguments to configure tvix-[ca]store services. +/// Provides a set of clap arguments to configure tvix-\[ca\]store services. /// /// This particular variant has defaults tailored for usecases accessing data /// from another running tvix daemon, via gRPC. @@ -70,7 +70,7 @@ pub struct ServiceUrlsGrpc { experimental_store_composition: Option, } -/// Provides a set clap arguments to configure tvix-[ca]store services. +/// Provides a set of clap arguments to configure tvix-\[ca\]store services. /// /// This particular variant has defaults tailored for usecases keeping all data /// in memory.