diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f8f29a9eb61..8545cb58761 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -206,7 +206,17 @@ benchmarks-test: # we may live with failing benchmarks, it is just a signal for us allow_failure: true -partial-repo-build-test: +check-rustdoc: + stage: test + <<: *docker-env + <<: *test-refs + variables: + SKIP_WASM_BUILD: 1 + RUSTDOCFLAGS: "-Dwarnings" + script: + - time cargo +nightly doc --workspace --verbose --no-deps --exclude relay-rialto-parachain-client + +partial-repo-pallets-build-test: stage: test <<: *docker-env <<: *nightly-test diff --git a/bin/rialto-parachain/runtime/src/lib.rs b/bin/rialto-parachain/runtime/src/lib.rs index 4e4fcffcd00..b5419e2c25e 100644 --- a/bin/rialto-parachain/runtime/src/lib.rs +++ b/bin/rialto-parachain/runtime/src/lib.rs @@ -16,7 +16,7 @@ //! The Rialto parachain runtime. This can be compiled with `#[no_std]`, ready for Wasm. //! -//! Originally a copy of runtime from https://github.com/substrate-developer-hub/substrate-parachain-template. +//! Originally a copy of runtime from . #![cfg_attr(not(feature = "std"), no_std)] // `construct_runtime!` does a lot of recursion and requires us to increase the limit to 256. diff --git a/bin/runtime-common/src/messages_xcm_extension.rs b/bin/runtime-common/src/messages_xcm_extension.rs index d4bf2bc1bed..3d802d12fad 100644 --- a/bin/runtime-common/src/messages_xcm_extension.rs +++ b/bin/runtime-common/src/messages_xcm_extension.rs @@ -15,11 +15,11 @@ // along with Parity Bridges Common. If not, see . //! Module provides utilities for easier XCM handling, e.g: -//! [`XcmExecutor`] -> [`MessageSender`] -> +//! `XcmExecutor` -> `MessageSender` -> `OutboundMessageQueue` //! | -//! +//! `Relayer` //! | -//! [`XcmRouter`] <- [`MessageDispatch`] <- +//! `XcmRouter` <- `MessageDispatch` <- `InboundMessageQueue` use bp_messages::{ source_chain::MessagesBridge, @@ -136,7 +136,7 @@ pub trait XcmBlobHauler { /// Runtime message sender adapter. type MessageSender: MessagesBridge; - /// Runtime message sender origin, which is used by [`MessageSender`]. + /// Runtime message sender origin, which is used by [`Self::MessageSender`]. type MessageSenderOrigin; /// Our location within the Consensus Universe. fn message_sender_origin() -> Self::MessageSenderOrigin; @@ -145,8 +145,8 @@ pub trait XcmBlobHauler { fn xcm_lane() -> LaneId; } -/// XCM bridge adapter which connects [`XcmBlobHauler`] with [`MessageSender`] and makes sure that -/// XCM blob is sent to the [`pallet_bridge_messages`] queue to be relayed. +/// XCM bridge adapter which connects [`XcmBlobHauler`] with [`XcmBlobHauler::MessageSender`] and +/// makes sure that XCM blob is sent to the [`pallet_bridge_messages`] queue to be relayed. pub struct XcmBlobHaulerAdapter(sp_std::marker::PhantomData); impl> HaulBlob for XcmBlobHaulerAdapter diff --git a/primitives/chain-millau/src/lib.rs b/primitives/chain-millau/src/lib.rs index 81ed5436263..b7f67ca07e2 100644 --- a/primitives/chain-millau/src/lib.rs +++ b/primitives/chain-millau/src/lib.rs @@ -86,12 +86,12 @@ pub const MAX_AUTHORITIES_COUNT: u32 = 5; /// Reasonable number of headers in the `votes_ancestries` on Millau chain. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const REASONABLE_HEADERS_IN_JUSTIFICATON_ANCESTRY: u32 = 8; /// Approximate average header size in `votes_ancestries` field of justification on Millau chain. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const AVERAGE_HEADER_SIZE_IN_JUSTIFICATION: u32 = 256; /// Approximate maximal header size on Millau chain. @@ -100,7 +100,7 @@ pub const AVERAGE_HEADER_SIZE_IN_JUSTIFICATION: u32 = 256; /// engine (GRANDPA, Babe, BEEFY, ...) - so we multiply it by 3. And also /// `AVERAGE_HEADER_SIZE_IN_JUSTIFICATION` bytes for other stuff. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const MAX_HEADER_SIZE: u32 = MAX_AUTHORITIES_COUNT .saturating_mul(3) .saturating_add(AVERAGE_HEADER_SIZE_IN_JUSTIFICATION); diff --git a/primitives/chain-rialto/src/lib.rs b/primitives/chain-rialto/src/lib.rs index a1c4a7267a7..01349f131be 100644 --- a/primitives/chain-rialto/src/lib.rs +++ b/primitives/chain-rialto/src/lib.rs @@ -75,12 +75,12 @@ pub const MAX_AUTHORITIES_COUNT: u32 = 5; /// Reasonable number of headers in the `votes_ancestries` on Rialto chain. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const REASONABLE_HEADERS_IN_JUSTIFICATON_ANCESTRY: u32 = 8; /// Approximate average header size in `votes_ancestries` field of justification on Rialto chain. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const AVERAGE_HEADER_SIZE_IN_JUSTIFICATION: u32 = 256; /// Approximate maximal header size on Rialto chain. @@ -89,7 +89,7 @@ pub const AVERAGE_HEADER_SIZE_IN_JUSTIFICATION: u32 = 256; /// engine (GRANDPA, Babe, BEEFY, ...) - so we multiply it by 3. And also /// `AVERAGE_HEADER_SIZE_IN_JUSTIFICATION` bytes for other stuff. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. pub const MAX_HEADER_SIZE: u32 = MAX_AUTHORITIES_COUNT .saturating_mul(3) .saturating_add(AVERAGE_HEADER_SIZE_IN_JUSTIFICATION); diff --git a/primitives/polkadot-core/src/lib.rs b/primitives/polkadot-core/src/lib.rs index eae2d49a6fd..3774d283fc4 100644 --- a/primitives/polkadot-core/src/lib.rs +++ b/primitives/polkadot-core/src/lib.rs @@ -54,7 +54,7 @@ pub const MAX_AUTHORITIES_COUNT: u32 = 1_256; /// Reasonable number of headers in the `votes_ancestries` on Polkadot-like chains. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. /// /// This value comes from recent (February, 2023) Kusama and Polkadot headers. There are no /// justifications with any additional headers in votes ancestry, so reasonable headers may @@ -65,7 +65,7 @@ pub const REASONABLE_HEADERS_IN_JUSTIFICATON_ANCESTRY: u32 = 2; /// Approximate average header size in `votes_ancestries` field of justification on Polkadot-like /// chains. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. /// /// This value comes from recent (February, 2023) Kusama headers. Average is `336` there, but some /// non-mandatory headers has size `40kb` (they contain the BABE epoch descriptor with all @@ -75,7 +75,7 @@ pub const AVERAGE_HEADER_SIZE_IN_JUSTIFICATION: u32 = 20 * 1024; /// Approximate maximal header size on Polkadot-like chains. /// -/// See [`bp_header_chain::ChainWithGrandpa`] for more details. +/// See [`bp-header-chain::ChainWithGrandpa`] for more details. /// /// This value comes from recent (February, 2023) Kusama headers. Maximal header is a mandatory /// header. In its SCALE-encoded form it is `80348` bytes. Let's have some reserve here. diff --git a/relays/lib-substrate-relay/src/messages_source.rs b/relays/lib-substrate-relay/src/messages_source.rs index a151af8ee82..de795beb787 100644 --- a/relays/lib-substrate-relay/src/messages_source.rs +++ b/relays/lib-substrate-relay/src/messages_source.rs @@ -16,7 +16,7 @@ //! Substrate client as Substrate messages source. The chain we connect to should have //! runtime that implements `HeaderApi` to allow bridging with -//! chain. +//! `` chain. use crate::{ messages_lane::{ diff --git a/relays/lib-substrate-relay/src/messages_target.rs b/relays/lib-substrate-relay/src/messages_target.rs index 7b0d9d63fb7..68b68b19936 100644 --- a/relays/lib-substrate-relay/src/messages_target.rs +++ b/relays/lib-substrate-relay/src/messages_target.rs @@ -16,7 +16,7 @@ //! Substrate client as Substrate messages target. The chain we connect to should have //! runtime that implements `HeaderApi` to allow bridging with -//! chain. +//! `` chain. use crate::{ messages_lane::{