about summary refs log tree commit diff
path: root/tvix/castore
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-11-09T14·20+0000
committerflokli <flokli@flokli.de>2024-11-11T18·46+0000
commita9f453f6da90c39c67df209d298062b751b93f73 (patch)
tree8995436a244569182730184f4b661a4c7d1475a6 /tvix/castore
parente71a857ec892f14ee7ce318f6753ba4af8d5ca4e (diff)
docs(tvix/[ca]store): improve docstrings, remove wildcard imports r/8901
Extend the docstrings of `add_default_services`, and add one for
`addrs_to_configs` as well as the module-wide one at
`tvix_store::composition`.

Change-Id: Ie9b449988eb210cd65b19b174094bbe0c4af2fd6
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12748
Tested-by: BuildkiteCI
Reviewed-by: yuka <yuka@yuka.dev>
Diffstat (limited to 'tvix/castore')
-rw-r--r--tvix/castore/src/composition.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/tvix/castore/src/composition.rs b/tvix/castore/src/composition.rs
index c3b6222d5d86..e997152d60be 100644
--- a/tvix/castore/src/composition.rs
+++ b/tvix/castore/src/composition.rs
@@ -270,9 +270,10 @@ pub static REG: LazyLock<&'static Registry> = LazyLock::new(|| {
 
 // ---------- End of generic registry code --------- //
 
-/// Register the builtin services of tvix_castore with the given registry.
-/// This is useful for creating your own registry with the builtin types _and_
-/// extra third party types.
+/// Register the builtin services of tvix_castore (blob services and directory
+/// services) with the given registry.
+/// This can be used outside to create your own registry with the builtin types
+/// _and_ extra third party types.
 pub fn add_default_services(reg: &mut Registry) {
     crate::blobservice::register_blob_services(reg);
     crate::directoryservice::register_directory_services(reg);