chore(docs): improve some comments (#13937)

* chore(docs): improve some comments

* Update client/network/common/src/sync/message.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

* Update client/rpc-api/src/chain/mod.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

* Update client/rpc/src/chain/mod.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

* Update client/rpc/src/chain/mod.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

* Update frame/staking/src/pallet/impls.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

---------

Co-authored-by: Koute <koute@users.noreply.github.com>
This commit is contained in:
yjh
2023-04-18 23:46:46 +08:00
committed by GitHub
parent e8e22b83b8
commit cbc8e5f7df
5 changed files with 7 additions and 7 deletions
@@ -185,7 +185,7 @@ pub mod generic {
pub blocks: Vec<BlockData<Header, Hash, Extrinsic>>,
}
/// Announce a new complete relay chain block on the network.
/// Announce a new complete block on the network.
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct BlockAnnounce<H> {
/// New block header.
@@ -32,7 +32,7 @@ pub struct WarpProofRequest<B: BlockT> {
/// The different types of warp syncing.
pub enum WarpSyncParams<Block: BlockT> {
/// Standard warp sync for the relay chain
/// Standard warp sync for the chain.
WithProvider(Arc<dyn WarpSyncProvider<Block>>),
/// Skip downloading proofs and wait for a header of the state that should be downloaded.
///
@@ -48,7 +48,7 @@ pub enum VerificationResult<Block: BlockT> {
Complete(SetId, AuthorityList, Block::Header),
}
/// Warp sync backend. Handles retrieveing and verifying warp sync proofs.
/// Warp sync backend. Handles retrieving and verifying warp sync proofs.
pub trait WarpSyncProvider<Block: BlockT>: Send + Sync {
/// Generate proof starting at given block hash. The proof is accumulated until maximum proof
/// size is reached.