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

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

View file

@ -1,9 +1,10 @@
use super::PathInfoService;
use crate::composition::{
with_registry, CompositionContext, DeserializeWithRegistry, ServiceBuilder, REG,
};
use crate::composition::REG;
use std::sync::Arc;
use tvix_castore::composition::{
with_registry, CompositionContext, DeserializeWithRegistry, ServiceBuilder,
};
use tvix_castore::Error;
use url::Url;
@ -56,11 +57,12 @@ pub async fn from_addr(
#[cfg(test)]
mod tests {
use super::from_addr;
use crate::composition::{Composition, DeserializeWithRegistry, ServiceBuilder, REG};
use crate::composition::REG;
use rstest::rstest;
use std::sync::LazyLock;
use tempfile::TempDir;
use tvix_castore::blobservice::{BlobService, MemoryBlobServiceConfig};
use tvix_castore::composition::{Composition, DeserializeWithRegistry, ServiceBuilder};
use tvix_castore::directoryservice::{DirectoryService, MemoryDirectoryServiceConfig};
static TMPDIR_REDB_1: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());