Reduce cargo doc warnings (#8947)

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Squirrel
2021-06-01 10:26:10 +01:00
committed by GitHub
parent 3b1c2f55b2
commit dc88e6dd7e
9 changed files with 17 additions and 18 deletions
+3 -4
View File
@@ -105,7 +105,7 @@ pub struct Params<B: BlockT, H: ExHashT> {
/// Request response configuration for the block request protocol.
///
/// [`RequestResponseConfig`] [`name`] is used to tag outgoing block requests with the correct
/// [`RequestResponseConfig::name`] is used to tag outgoing block requests with the correct
/// protocol name. In addition all of [`RequestResponseConfig`] is used to handle incoming block
/// requests, if enabled.
///
@@ -171,7 +171,7 @@ pub enum TransactionImport {
None,
}
/// Fuure resolving to transaction import result.
/// Future resolving to transaction import result.
pub type TransactionImportFuture = Pin<Box<dyn Future<Output=TransactionImport> + Send>>;
/// Transaction pool interface
@@ -599,8 +599,7 @@ pub enum TransportConfig {
/// If true, allow connecting to private IPv4 addresses (as defined in
/// [RFC1918](https://tools.ietf.org/html/rfc1918)). Irrelevant for addresses that have
/// been passed in [`NetworkConfiguration::reserved_nodes`] or
/// [`NetworkConfiguration::boot_nodes`].
/// been passed in [`NetworkConfiguration::boot_nodes`].
allow_private_ipv4: bool,
/// Optional external implementation of a libp2p transport. Used in WASM contexts where we
@@ -25,7 +25,7 @@
//! 2. Forward the request to [`crate::request_responses::RequestResponsesBehaviour`] via
//! [`OutEvent::SendRequest`].
//!
//! 3. Wait for the response and forward the response via the [`oneshot::Sender`] provided earlier
//! 3. Wait for the response and forward the response via the [`futures::channel::oneshot::Sender`] provided earlier
//! with [`LightClientRequestSender::send_request`].
use codec::{self, Encode, Decode};
@@ -552,7 +552,7 @@ pub enum OutEvent {
target: PeerId,
/// The encoded request.
request: Vec<u8>,
/// The [`onehsot::Sender`] channel to pass the response to.
/// The [`oneshot::Sender`] channel to pass the response to.
pending_response: oneshot::Sender<Result<Vec<u8>, RequestFailure>>,
/// The name of the protocol to use to send the request.
protocol_name: String,
+1 -1
View File
@@ -925,7 +925,7 @@ impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H> {
}
}
/// You may call this when new transactons are imported by the transaction pool.
/// You may call this when new transactions are imported by the transaction pool.
///
/// All transactions will be fetched from the `TransactionPool` that was passed at
/// initialization as part of the configuration and propagated to peers.