From 8069e1e70d0c6d3ffc047006e720f29134bad111 Mon Sep 17 00:00:00 2001 From: nazeh Date: Thu, 12 Dec 2024 12:02:49 +0300 Subject: [PATCH] docs: fix few places that uses Settings instead of Config --- pkarr/src/client/dht.rs | 2 +- pkarr/src/extra/lmdb_cache.rs | 2 +- relay/src/config.rs | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pkarr/src/client/dht.rs b/pkarr/src/client/dht.rs index 0038ee5..ffa28af 100644 --- a/pkarr/src/client/dht.rs +++ b/pkarr/src/client/dht.rs @@ -122,7 +122,7 @@ impl ClientBuilder { self } - /// Convienent methot to set the [mainline::Settings::bootstrap] from [mainline::Testnet::bootstrap] + /// Convienent methot to set the [mainline::Config::bootstrap] from [mainline::Testnet::bootstrap] pub fn testnet(mut self, testnet: &Testnet) -> Self { self.0.dht_config.bootstrap = testnet.bootstrap.clone(); diff --git a/pkarr/src/extra/lmdb_cache.rs b/pkarr/src/extra/lmdb_cache.rs index bebf879..f7c3a3e 100644 --- a/pkarr/src/extra/lmdb_cache.rs +++ b/pkarr/src/extra/lmdb_cache.rs @@ -68,7 +68,7 @@ impl<'a> BytesDecode<'a> for SignedPacketCodec { } #[derive(Debug, Clone)] -/// Persistent [crate::base::cache::Cache] implementation using LMDB's bindings [heed] +/// Persistent [crate::Cache] implementation using LMDB's bindings [heed] pub struct LmdbCache { capacity: usize, env: Env, diff --git a/relay/src/config.rs b/relay/src/config.rs index ffa799c..68e7fc3 100644 --- a/relay/src/config.rs +++ b/relay/src/config.rs @@ -17,9 +17,9 @@ struct ConfigToml { mainline: Option, cache_path: Option, cache_size: Option, - /// See [pkarr::Settings::minimum_ttl] + /// See [pkarr::Config::minimum_ttl] minimum_ttl: Option, - /// See [pkarr::Settings::maximum_ttl] + /// See [pkarr::Config::maximum_ttl] maximum_ttl: Option, rate_limiter: RateLimiterConfig, } @@ -49,7 +49,7 @@ pub struct Config { /// /// Defaults to a directory in the OS data directory pub cache_path: Option, - /// See [pkarr::client::Settings::cache_size] + /// See [pkarr::client::Config::cache_size] /// /// Defaults to 1000_000 pub cache_size: usize,