From e75607108edeb96694c32c54a858817f99079861 Mon Sep 17 00:00:00 2001 From: Mira Ressel Date: Fri, 16 Jun 2023 13:14:16 +0200 Subject: [PATCH] docs: update references to NetworkConfiguration::extra_sets (#7386) * docs: update references to NetworkConfiguration::extra_sets Since paritytech/substrate#14080, this struct field no longer exists, now the `add_notification_protocol()` function of `sc_network::config::FullNetworkConfiguration` is used. Also neuter the doc links for now; rustdoc can't resolve them (presumably because sc_network::config isn't in scope, though weirdly enough even spelling the link out as ``[`FullNetworkConfiguration`](struct@sc_network::config::FullNetworkConfiguration)`` doesn't work?). Normally this wouldn't be an issue and rustdoc would just not generate links, but rust 1.70 has a bug that completely crashes rustdoc in this case. --- polkadot/node/network/bridge/src/lib.rs | 2 +- polkadot/node/network/bridge/src/rx/mod.rs | 2 +- polkadot/node/network/bridge/src/tx/mod.rs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/polkadot/node/network/bridge/src/lib.rs b/polkadot/node/network/bridge/src/lib.rs index 0dd6227b71..46d4a00faa 100644 --- a/polkadot/node/network/bridge/src/lib.rs +++ b/polkadot/node/network/bridge/src/lib.rs @@ -34,7 +34,7 @@ use polkadot_node_network_protocol::{ /// Peer set info for network initialization. /// -/// To be added to [`NetworkConfiguration::extra_sets`]. +/// To be passed to [`FullNetworkConfiguration::add_notification_protocol`](). pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority}; use std::{collections::HashMap, sync::Arc}; diff --git a/polkadot/node/network/bridge/src/rx/mod.rs b/polkadot/node/network/bridge/src/rx/mod.rs index 499a73f0a4..e757b28221 100644 --- a/polkadot/node/network/bridge/src/rx/mod.rs +++ b/polkadot/node/network/bridge/src/rx/mod.rs @@ -49,7 +49,7 @@ use polkadot_primitives::{AuthorityDiscoveryId, BlockNumber, Hash, ValidatorInde /// Peer set info for network initialization. /// -/// To be added to [`NetworkConfiguration::extra_sets`]. +/// To be passed to [`FullNetworkConfiguration::add_notification_protocol`](). pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority}; use std::{ diff --git a/polkadot/node/network/bridge/src/tx/mod.rs b/polkadot/node/network/bridge/src/tx/mod.rs index ff2e60fbe8..2b54f6f0f0 100644 --- a/polkadot/node/network/bridge/src/tx/mod.rs +++ b/polkadot/node/network/bridge/src/tx/mod.rs @@ -31,7 +31,7 @@ use polkadot_node_subsystem::{ /// Peer set info for network initialization. /// -/// To be added to [`NetworkConfiguration::extra_sets`]. +/// To be passed to [`FullNetworkConfiguration::add_notification_protocol`](). pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority}; use sc_network::ReputationChange;