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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
altaua
added
A2-insubstantial
bkchr
approved these changes
Jun 16, 2023
node/network/bridge/src/lib.rs
Outdated
| @@ -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`](). | |||
There was a problem hiding this comment.
Suggested change
| /// To be added to [`FullNetworkConfiguration`](). | |
| /// To be passed to [`FullNetworkConfiguration::add_notification_protocol`](sc_network::config::FullNetworkConfiguration::add_notification_protocol). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Then this should be reported upstream.
altonen
approved these changes
Jun 16, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since paritytech/substrate#14080, this struct field no longer exists, now the
add_notification_protocol()function ofsc_network::config::FullNetworkConfigurationis 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.Required for https://github.com/paritytech/ci_cd/issues/816