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

docs(tvix/[ca]store): improve docstrings, remove wildcard imports

Browse source 
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>
This commit is contained in:
Florian Klink 2024-11-09 14:20:03 +00:00 • committed by flokli
parent e71a857ec8
commit a9f453f6da
4 changed files with 31 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

7
tvix/castore/src/composition.rs
View file

@ -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);