Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

docs: update references to NetworkConfiguration::extra_sets #7386

Merged
merged 2 commits into from
Jun 16, 2023
Merged

docs: update references to NetworkConfiguration::extra_sets #7386

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2220393
docs: update references to NetworkConfiguration::extra_sets
Jun 15, 2023
690574a
apply basti's phrasing suggestion
Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion node/network/bridge/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ use polkadot_node_network_protocol::{

/// Peer set info for network initialization.
///
/// To be added to [`NetworkConfiguration::extra_sets`].
/// To be added to [`FullNetworkConfiguration`]().
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// To be added to [`FullNetworkConfiguration`]().
/// To be passed to [`FullNetworkConfiguration::add_notification_protocol`](sc_network::config::FullNetworkConfiguration::add_notification_protocol).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've applied your suggestions. I'm still leaving the () link part at the end empty though; rustdoc doesn't seem to be able to resolve sc_network::config::FullNetworkConfiguration::add_notification_protocol, and that's triggering the aforementioned crashing bug in 1.70.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then this should be reported upstream.

pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority};

use std::{collections::HashMap, sync::Arc};
Expand Down
2 changes: 1 addition & 1 deletion node/network/bridge/src/rx/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 added to [`FullNetworkConfiguration`]().
altaua marked this conversation as resolved.
Show resolved Hide resolved
pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority};

use std::{
Expand Down
2 changes: 1 addition & 1 deletion node/network/bridge/src/tx/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ use polkadot_node_subsystem::{

/// Peer set info for network initialization.
///
/// To be added to [`NetworkConfiguration::extra_sets`].
/// To be added to [`FullNetworkConfiguration`]().
altaua marked this conversation as resolved.
Show resolved Hide resolved
pub use polkadot_node_network_protocol::peer_set::{peer_sets_info, IsAuthority};
use sc_network::ReputationChange;

Expand Down