Fix test-rustdoc (#1266)

* Fix `test-rustdoc`

* ".git/.scripts/commands/fmt/fmt.sh"

---------

Co-authored-by: command-bot <>

polkadot/node/core/parachains-inherent/src/lib.rs

@@ -19,7 +19,7 @@
 //! Parachain backing and approval is an off-chain process, but the parachain needs to progress on
 //! chain as well. To make it progress on chain a block producer needs to forward information about
 //! the state of a parachain to the runtime. This information is forwarded through an inherent to
-//! the runtime. Here we provide the [`ParachainInherentDataProvider`] that requests the relevant
+//! the runtime. Here we provide the [`ParachainsInherentDataProvider`] that requests the relevant
 //! data from the provisioner subsystem and creates the the inherent data that the runtime will use
 //! to create an inherent.
 

polkadot/node/core/pvf/common/src/executor_intf.rs

@@ -141,7 +141,7 @@ impl Executor {
 	/// # Safety
 	///
 	/// The caller must ensure that the compiled artifact passed here was:
-	///   1) produced by [`prepare`],
+	///   1) produced by `prepare`,
 	///   2) was not modified,
 	///
 	/// Failure to adhere to these requirements might lead to crashes and arbitrary code execution.
@@ -171,7 +171,7 @@ impl Executor {
 	/// # Safety
 	///
 	/// The caller must ensure that the compiled artifact passed here was:
-	///   1) produced by [`prepare`],
+	///   1) produced by `prepare`,
 	///   2) was not modified,
 	///
 	/// Failure to adhere to these requirements might lead to crashes and arbitrary code execution.

polkadot/node/network/bridge/src/rx/mod.rs

@@ -92,7 +92,7 @@ impl<N, AD> NetworkBridgeRx<N, AD> {
 	/// discovery service.
 	///
 	/// This assumes that the network service has had the notifications protocol for the network
-	/// bridge already registered. See [`peers_sets_info`](peers_sets_info).
+	/// bridge already registered. See [`peer_sets_info`].
 	pub fn new(
 		network_service: N,
 		authority_discovery_service: AD,

polkadot/node/network/bridge/src/tx/mod.rs

@@ -65,7 +65,7 @@ impl<N, AD> NetworkBridgeTx<N, AD> {
 	/// discovery service.
 	///
 	/// This assumes that the network service has had the notifications protocol for the network
-	/// bridge already registered. See [`peers_sets_info`](peers_sets_info).
+	/// bridge already registered. See [`peer_sets_info`].
 	pub fn new(
 		network_service: N,
 		authority_discovery_service: AD,

polkadot/node/network/protocol/src/authority_discovery.rs

@@ -30,12 +30,12 @@ use sc_network::{Multiaddr, PeerId};
 /// Needed for mocking in tests mostly.
 #[async_trait]
 pub trait AuthorityDiscovery: Send + Debug + 'static {
-	/// Get the addresses for the given [`AuthorityId`] from the local address cache.
+	/// Get the addresses for the given [`AuthorityDiscoveryId`] from the local address cache.
 	async fn get_addresses_by_authority_id(
 		&mut self,
 		authority: AuthorityDiscoveryId,
 	) -> Option<HashSet<Multiaddr>>;
-	/// Get the [`AuthorityId`] for the given [`PeerId`] from the local address cache.
+	/// Get the [`AuthorityDiscoveryId`] for the given [`PeerId`] from the local address cache.
 	async fn get_authority_ids_by_peer_id(
 		&mut self,
 		peer_id: PeerId,

polkadot/node/network/protocol/src/peer_set.rs

@@ -197,7 +197,7 @@ impl<T> IndexMut<PeerSet> for PerPeerSet<T> {
 
 /// Get `NonDefaultSetConfig`s for all available peer sets, at their default versions.
 ///
-/// Should be used during network configuration (added to [`NetworkConfiguration::extra_sets`])
+/// Should be used during network configuration (added to `NetworkConfiguration::extra_sets`)
 /// or shortly after startup to register the protocols with the network service.
 pub fn peer_sets_info(
 	is_authority: IsAuthority,
@@ -288,7 +288,7 @@ pub struct PeerSetProtocolNames {
 }
 
 impl PeerSetProtocolNames {
-	/// Construct [`PeerSetProtocols`] using `genesis_hash` and `fork_id`.
+	/// Construct [`PeerSetProtocolNames`] using `genesis_hash` and `fork_id`.
 	pub fn new(genesis_hash: Hash, fork_id: Option<&str>) -> Self {
 		let mut protocols = HashMap::new();
 		let mut names = HashMap::new();

polkadot/node/primitives/src/disputes/mod.rs

@@ -263,9 +263,9 @@ impl SignedDisputeStatement {
 		self.session_index
 	}
 
-	/// Convert a [`SignedFullStatement`] to a [`SignedDisputeStatement`]
+	/// Convert a unchecked backing statement to a [`SignedDisputeStatement`]
 	///
-	/// As [`SignedFullStatement`] contains only the validator index and
+	/// As the unchecked backing statement contains only the validator index and
 	/// not the validator public key, the public key must be passed as well,
 	/// along with the signing context.
 	///

polkadot/node/primitives/src/lib.rs

@@ -463,8 +463,8 @@ impl CollationResult {
 /// Collation function.
 ///
 /// Will be called with the hash of the relay chain block the parachain block should be build on and
-/// the [`ValidationData`] that provides information about the state of the parachain on the relay
-/// chain.
+/// the [`PersistedValidationData`] that provides information about the state of the parachain on
+/// the relay chain.
 ///
 /// Returns an optional [`CollationResult`].
 #[cfg(not(target_os = "unknown"))]
@@ -498,7 +498,7 @@ impl std::fmt::Debug for CollationGenerationConfig {
 	}
 }
 
-/// Parameters for [`CollationGenerationMessage::SubmitCollation`].
+/// Parameters for `CollationGenerationMessage::SubmitCollation`.
 #[derive(Debug)]
 pub struct SubmitCollationParams {
 	/// The relay-parent the collation is built against.
@@ -634,7 +634,7 @@ pub struct ErasureChunk {
 }
 
 impl ErasureChunk {
-	/// Convert bounded Vec Proof to regular Vec<Vec<u8>>
+	/// Convert bounded Vec Proof to regular `Vec<Vec<u8>>`
 	pub fn proof(&self) -> &Proof {
 		&self.proof
 	}

polkadot/node/service/src/benchmarking.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
-//! Code related to benchmarking a [`crate::Client`].
+//! Code related to benchmarking a node.
 
 use polkadot_primitives::AccountId;
 use sc_client_api::UsageProvider;

polkadot/node/service/src/overseer.rs

@@ -139,7 +139,7 @@ where
 	pub overseer_message_channel_capacity_override: Option<usize>,
 	/// Request-response protocol names source.
 	pub req_protocol_names: ReqProtocolNames,
-	/// [`PeerSet`] protocol names to protocols mapping.
+	/// `PeerSet` protocol names to protocols mapping.
 	pub peerset_protocol_names: PeerSetProtocolNames,
 	/// The offchain transaction pool factory.
 	pub offchain_transaction_pool_factory: OffchainTransactionPoolFactory<Block>,

polkadot/node/test/client/src/block_builder.rs

@@ -41,7 +41,7 @@ pub trait InitPolkadotBlockBuilder {
 	/// Init a Polkadot specific block builder at a specific block that works for the test runtime.
 	///
 	/// Same as [`InitPolkadotBlockBuilder::init_polkadot_block_builder`] besides that it takes a
-	/// [`BlockId`] to say which should be the parent block of the block that is being build.
+	/// `Hash` to say which should be the parent block of the block that is being build.
 	fn init_polkadot_block_builder_at(
 		&self,
 		hash: <Block as BlockT>::Hash,