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

Commit 26129de

Browse files
committed
revert removal of outdated/private links
1 parent c3ba947 commit 26129de

File tree

6 files changed

+20
-21
lines changed

6 files changed

+20
-21
lines changed

client/authority-discovery/src/worker.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ pub enum Role {
8585
///
8686
/// 4. Put addresses and signature as a record with the authority id as a key on a Kademlia DHT.
8787
///
88-
/// When constructed with either [`Role::PublishAndDiscover`] or `Role::Publish` a [`Worker`] will
88+
/// When constructed with either [`Role::PublishAndDiscover`] or [`Role::Publish`] a [`Worker`] will
8989
///
9090
/// 1. Retrieve the current and next set of authorities.
9191
///

client/network/src/block_request_handler.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
1616

1717
//! Helper for handling (i.e. answering) block requests from a remote peer via the
18-
//! `crate::request_responses::RequestResponsesBehaviour`.
18+
//! [`crate::request_responses::RequestResponsesBehaviour`].
1919
2020
use codec::{Encode, Decode};
2121
use crate::chain::Client;

client/network/src/config.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ pub struct Params<B: BlockT, H: ExHashT> {
105105

106106
/// Request response configuration for the block request protocol.
107107
///
108-
/// [`RequestResponseConfig`] `name` is used to tag outgoing block requests with the correct
108+
/// [`RequestResponseConfig`] [`name`] is used to tag outgoing block requests with the correct
109109
/// protocol name. In addition all of [`RequestResponseConfig`] is used to handle incoming block
110110
/// requests, if enabled.
111111
///
@@ -555,7 +555,7 @@ pub enum TransportConfig {
555555

556556
/// If true, allow connecting to private IPv4 addresses (as defined in
557557
/// [RFC1918](https://tools.ietf.org/html/rfc1918)). Irrelevant for addresses that have
558-
/// been passed in `NetworkConfiguration::reserved_nodes` or
558+
/// been passed in [`NetworkConfiguration::reserved_nodes`] or
559559
/// [`NetworkConfiguration::boot_nodes`].
560560
allow_private_ipv4: bool,
561561

client/network/src/light_client_requests/handler.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@
1919
//! Helper for incoming light client requests.
2020
//!
2121
//! Handle (i.e. answer) incoming light client requests from a remote peer received via
22-
//! `crate::request_responses::RequestResponsesBehaviour` with
23-
//! [`crate::light_client_requests::handler::LightClientRequestHandler`].
22+
//! [`crate::request_responses::RequestResponsesBehaviour`] with [`LightClientRequestHandler`].
2423
2524
use codec::{self, Encode, Decode};
2625
use crate::{

client/network/src/light_client_requests/sender.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818

1919
//! Helper for outgoing light client requests.
2020
//!
21-
//! Call `LightClientRequestSender::send_request` to send out light client requests. It will:
21+
//! Call [`LightClientRequestSender::send_request`] to send out light client requests. It will:
2222
//!
2323
//! 1. Build the request.
2424
//!
25-
//! 2. Forward the request to `crate::request_responses::RequestResponsesBehaviour` via
26-
//! `OutEvent::SendRequest`.
25+
//! 2. Forward the request to [`crate::request_responses::RequestResponsesBehaviour`] via
26+
//! [`OutEvent::SendRequest`].
2727
//!
28-
//! 3. Wait for the response and forward the response via the `oneshot::Sender` provided earlier
29-
//! with `LightClientRequestSender::send_request`.
28+
//! 3. Wait for the response and forward the response via the [`oneshot::Sender`] provided earlier
29+
//! with [`LightClientRequestSender::send_request`].
3030
3131
use codec::{self, Encode, Decode};
3232
use crate::{
@@ -546,13 +546,13 @@ impl<B: Block> Stream for LightClientRequestSender<B> {
546546
/// Events returned by [`LightClientRequestSender`].
547547
#[derive(Debug)]
548548
pub enum OutEvent {
549-
/// Emit a request to be send out on the network e.g. via `crate::request_responses`.
549+
/// Emit a request to be send out on the network e.g. via [`crate::request_responses`].
550550
SendRequest {
551551
/// The remote peer to send the request to.
552552
target: PeerId,
553553
/// The encoded request.
554554
request: Vec<u8>,
555-
/// The `onehsot::Sender` channel to pass the response to.
555+
/// The [`onehsot::Sender`] channel to pass the response to.
556556
pending_response: oneshot::Sender<Result<Vec<u8>, RequestFailure>>,
557557
/// The name of the protocol to use to send the request.
558558
protocol_name: String,
@@ -643,42 +643,42 @@ pub enum Request<B: Block> {
643643
Body {
644644
/// Request.
645645
request: RemoteBodyRequest<B::Header>,
646-
/// `oneshot::Sender` to return response.
646+
/// [`oneshot::Sender`] to return response.
647647
sender: oneshot::Sender<Result<Vec<B::Extrinsic>, ClientError>>
648648
},
649649
/// Remote header request.
650650
Header {
651651
/// Request.
652652
request: light::RemoteHeaderRequest<B::Header>,
653-
/// `oneshot::Sender` to return response.
653+
/// [`oneshot::Sender`] to return response.
654654
sender: oneshot::Sender<Result<B::Header, ClientError>>
655655
},
656656
/// Remote read request.
657657
Read {
658658
/// Request.
659659
request: light::RemoteReadRequest<B::Header>,
660-
/// `oneshot::Sender` to return response.
660+
/// [`oneshot::Sender`] to return response.
661661
sender: oneshot::Sender<Result<HashMap<Vec<u8>, Option<Vec<u8>>>, ClientError>>
662662
},
663663
/// Remote read child request.
664664
ReadChild {
665665
/// Request.
666666
request: light::RemoteReadChildRequest<B::Header>,
667-
/// `oneshot::Sender` to return response.
667+
/// [`oneshot::Sender`] to return response.
668668
sender: oneshot::Sender<Result<HashMap<Vec<u8>, Option<Vec<u8>>>, ClientError>>
669669
},
670670
/// Remote call request.
671671
Call {
672672
/// Request.
673673
request: light::RemoteCallRequest<B::Header>,
674-
/// `oneshot::Sender` to return response.
674+
/// [`oneshot::Sender`] to return response.
675675
sender: oneshot::Sender<Result<Vec<u8>, ClientError>>
676676
},
677677
/// Remote changes request.
678678
Changes {
679679
/// Request.
680680
request: light::RemoteChangesRequest<B::Header>,
681-
/// `oneshot::Sender` to return response.
681+
/// [`oneshot::Sender`] to return response.
682682
sender: oneshot::Sender<Result<Vec<(NumberFor<B>, u32)>, ClientError>>
683683
}
684684
}

client/network/src/service.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H> {
665665
/// > preventing the message from being delivered.
666666
///
667667
/// The protocol must have been registered with
668-
/// `NetworkConfiguration::notifications_protocols`
668+
/// [`NetworkConfiguration::notifications_protocols`](crate::config::NetworkConfiguration::notifications_protocols).
669669
///
670670
pub fn write_notification(&self, target: PeerId, protocol: Cow<'static, str>, message: Vec<u8>) {
671671
// We clone the `NotificationsSink` in order to be able to unlock the network-wide
@@ -726,7 +726,7 @@ impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H> {
726726
/// in which case enqueued notifications will be lost.
727727
///
728728
/// The protocol must have been registered with
729-
/// `NetworkConfiguration::notifications_protocols`
729+
/// [`NetworkConfiguration::notifications_protocols`](crate::config::NetworkConfiguration::notifications_protocols).
730730
///
731731
/// # Usage
732732
///

0 commit comments

Comments
 (0)