Skip to content

Commit

Permalink
docs(pkarr): fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuhvi committed Feb 5, 2025
1 parent b338d1a commit 92cd938
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/rust.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ jobs:
key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-registry-
- name: Cache cargo index
uses: actions/cache@v2
with:
path: ~/.cargo/git
key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-index-
- name: Cache cargo build
id: cargo-build-cache
uses: actions/cache@v2
Expand All @@ -46,6 +48,7 @@ jobs:
key: ${{ runner.os }}-cargo-build-${{ hashFiles('./Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-build-
- name: Cache Nextest installation
uses: actions/cache@v2
with:
Expand Down
8 changes: 4 additions & 4 deletions pkarr/src/client/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub const DEFAULT_REQUEST_TIMEOUT: Duration = Duration::from_secs(2);

/// [Client]'s Config
#[derive(Clone)]
pub struct Config {
pub(crate) struct Config {
/// Defaults to [DEFAULT_CACHE_SIZE]
pub cache_size: usize,
/// Used in the `min` parameter in [crate::SignedPacket::expires_in].
Expand Down Expand Up @@ -150,7 +150,7 @@ impl ClientBuilder {
///
/// You can start a separate Dht network by setting this to an empty array.
///
/// If you want to extend [Config::dht_config::bootstrap][mainline::Config::bootstrap] nodes with more nodes, you can
/// If you want to extend [bootstrap][mainline::DhtBuilder::bootstrap] nodes with more nodes, you can
/// use [Self::extra_bootstrap].
#[cfg(all(feature = "dht", not(target_family = "wasm")))]
pub fn bootstrap<T: ToSocketAddrs>(&mut self, bootstrap: &[T]) -> &mut Self {
Expand All @@ -176,13 +176,13 @@ impl ClientBuilder {
self
}

#[cfg(all(feature = "dht", not(target_family = "wasm")))]
/// Set custom set of [resolvers](https://pkarr.org/resolvers).
///
/// You can disable resolvers using [Self::no_resolvers].
///
/// If you want to extend the [Config::resolvers] with more nodes, you can
/// If you want to extend the resolvers with more nodes, you can
/// use [Self::extra_resolvers].
#[cfg(all(feature = "dht", not(target_family = "wasm")))]
pub fn resolvers<T: ToSocketAddrs>(&mut self, resolvers: &[T]) -> &mut Self {
self.0.resolvers = Some(resolvers_to_socket_addrs(resolvers));

Expand Down
4 changes: 0 additions & 4 deletions pkarr/src/client/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,6 @@ async fn concurrent_publish_of_different_packets(#[case] networks: Networks) {
#[cfg_attr(feature = "relays", case::relays(Networks::Relays))]
#[tokio::test]
async fn concurrent_publish_different_with_cas(#[case] networks: Networks) {
tracing_subscriber::fmt()
.with_env_filter("tower_http=debug")
.init();

let testnet = mainline::Testnet::new(10).unwrap();
let relay = Relay::start_test(&testnet).await.unwrap();

Expand Down

0 comments on commit 92cd938

Please sign in to comment.