Skip to content

Commit

Permalink
docs: fix few places that uses Settings instead of Config
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuhvi committed Dec 12, 2024
1 parent 5f58f13 commit 8069e1e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pkarr/src/client/dht.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
2 changes: 1 addition & 1 deletion pkarr/src/extra/lmdb_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions relay/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ struct ConfigToml {
mainline: Option<MainlineConfig>,
cache_path: Option<String>,
cache_size: Option<usize>,
/// See [pkarr::Settings::minimum_ttl]
/// See [pkarr::Config::minimum_ttl]
minimum_ttl: Option<u32>,
/// See [pkarr::Settings::maximum_ttl]
/// See [pkarr::Config::maximum_ttl]
maximum_ttl: Option<u32>,
rate_limiter: RateLimiterConfig,
}
Expand Down Expand Up @@ -49,7 +49,7 @@ pub struct Config {
///
/// Defaults to a directory in the OS data directory
pub cache_path: Option<PathBuf>,
/// See [pkarr::client::Settings::cache_size]
/// See [pkarr::client::Config::cache_size]
///
/// Defaults to 1000_000
pub cache_size: usize,
Expand Down

0 comments on commit 8069e1e

Please sign in to comment.