Use intra doc in network-gossip (#10501)

* Use intra doc in network-gossip

So that we could jump to the definition easily.

* cargo +nightly fmt --all
This commit is contained in:
Liu-Cheng Xu
2021-12-17 07:19:30 +08:00
committed by GitHub
parent 9b73a8a6fc
commit 472e29f843
2 changed files with 15 additions and 15 deletions
@@ -39,7 +39,7 @@ use std::{
task::{Context, Poll},
};
/// Wraps around an implementation of the `Network` crate and provides gossiping capabilities on
/// Wraps around an implementation of the [`Network`] trait and provides gossiping capabilities on
/// top of it.
pub struct GossipEngine<B: BlockT> {
state_machine: ConsensusGossip<B>,
@@ -56,7 +56,7 @@ pub struct GossipEngine<B: BlockT> {
}
/// A gossip engine receives messages from the network via the `network_event_stream` and forwards
/// them to upper layers via the `message sinks`. In the scenario where messages have been received
/// them to upper layers via the `message_sinks`. In the scenario where messages have been received
/// from the network but a subscribed message sink is not yet ready to receive the messages, the
/// messages are buffered. To model this process a gossip engine can be in two states.
enum ForwardingState<B: BlockT> {