From f85fabd753c40041edcaac487f6f1ce259e8d11b Mon Sep 17 00:00:00 2001 From: Dan Forbes Date: Mon, 1 Jun 2020 13:54:13 -0700 Subject: [PATCH] Fix Rustdoc Build (#6207) --- bin/node/testing/src/bench.rs | 2 +- client/cli/src/lib.rs | 6 +++--- client/consensus/slots/src/lib.rs | 1 - frame/session/src/lib.rs | 2 +- frame/staking/src/lib.rs | 2 +- primitives/runtime/src/offchain/storage_lock.rs | 4 ++-- 6 files changed, 8 insertions(+), 9 deletions(-) diff --git a/bin/node/testing/src/bench.rs b/bin/node/testing/src/bench.rs index 5b8f2e2083858..fc5daa80ad63e 100644 --- a/bin/node/testing/src/bench.rs +++ b/bin/node/testing/src/bench.rs @@ -222,7 +222,7 @@ impl CloneableSpawn for TaskExecutor { impl BenchDb { /// New immutable benchmarking database. /// - /// See [`new`] method documentation for more information about the purpose + /// See [`BenchDb::new`] method documentation for more information about the purpose /// of this structure. pub fn with_key_types( database_type: DatabaseType, diff --git a/client/cli/src/lib.rs b/client/cli/src/lib.rs index 36d3649926f90..2ea59129ea05e 100644 --- a/client/cli/src/lib.rs +++ b/client/cli/src/lib.rs @@ -165,9 +165,9 @@ pub trait SubstrateCli: Sized { /// Print the error message and quit the program in case of failure. /// /// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are - /// used. It will return a [`clap::Error`], where the [`kind`] is a - /// [`ErrorKind::HelpDisplayed`] or [`ErrorKind::VersionDisplayed`] respectively. You must call - /// [`Error::exit`] or perform a [`std::process::exit`]. + /// used. It will return a [`clap::Error`], where the [`clap::Error::kind`] is a + /// [`clap::ErrorKind::HelpDisplayed`] or [`clap::ErrorKind::VersionDisplayed`] respectively. + /// You must call [`clap::Error::exit`] or perform a [`std::process::exit`]. fn try_from_iter(iter: I) -> clap::Result where Self: StructOpt + Sized, diff --git a/client/consensus/slots/src/lib.rs b/client/consensus/slots/src/lib.rs index bfa2747e21ebe..fe1c6bab7b579 100644 --- a/client/consensus/slots/src/lib.rs +++ b/client/consensus/slots/src/lib.rs @@ -20,7 +20,6 @@ //! time during which certain events can and/or must occur. This crate //! provides generic functionality for slots. -#![deny(warnings)] #![forbid(unsafe_code, missing_docs)] mod slots; diff --git a/frame/session/src/lib.rs b/frame/session/src/lib.rs index 47517702cc57a..6f5630adf9ecf 100644 --- a/frame/session/src/lib.rs +++ b/frame/session/src/lib.rs @@ -219,7 +219,7 @@ pub trait SessionHandler { /// All the key type ids this session handler can process. /// /// The order must be the same as it expects them in - /// [`on_new_session`](Self::on_new_session) and [`on_genesis_session`](Self::on_genesis_session). + /// [`on_new_session`](Self::on_new_session) and [`on_genesis_session`](Self::on_genesis_session). const KEY_TYPE_IDS: &'static [KeyTypeId]; /// The given validator set will be used for the genesis session. diff --git a/frame/staking/src/lib.rs b/frame/staking/src/lib.rs index b97469b8e098e..535eb4446b70f 100644 --- a/frame/staking/src/lib.rs +++ b/frame/staking/src/lib.rs @@ -108,7 +108,7 @@ //! Rewards must be claimed for each era before it gets too old by `$HISTORY_DEPTH` using the //! `payout_stakers` call. Any account can call `payout_stakers`, which pays the reward to //! the validator as well as its nominators. -//! Only the [`T::MaxNominatorRewardedPerValidator`] biggest stakers can claim their reward. This +//! Only the [`Trait::MaxNominatorRewardedPerValidator`] biggest stakers can claim their reward. This //! is to limit the i/o cost to mutate storage for each nominator's account. //! //! Slashing can occur at any point in time, once misbehavior is reported. Once slashing is diff --git a/primitives/runtime/src/offchain/storage_lock.rs b/primitives/runtime/src/offchain/storage_lock.rs index 641aebed43754..f8defa422459f 100644 --- a/primitives/runtime/src/offchain/storage_lock.rs +++ b/primitives/runtime/src/offchain/storage_lock.rs @@ -241,7 +241,7 @@ impl Lockable for BlockAndTime { /// /// A lock that is persisted in the DB and provides the ability to guard against /// concurrent access in an off-chain worker, with a defined expiry deadline -/// based on the concrete [`Lockable`](Self::Lockable) implementation. +/// based on the concrete [`Lockable`](Lockable) implementation. pub struct StorageLock<'a, L = Time> { // A storage value ref which defines the DB entry representing the lock. value_ref: StorageValueRef<'a>, @@ -396,7 +396,7 @@ where } /// Bound for a block number source -/// used with [`BlockAndTime`](Self::BlockAndTime). +/// used with [`BlockAndTime`](BlockAndTime). pub trait BlockNumberProvider { /// Type of `BlockNumber` to provide. type BlockNumber: Codec + Clone + Ord + Eq + AtLeast32Bit;