mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-14 01:41:09 +00:00
WIP: CI: add spellcheck (#3421)
* CI: add spellcheck * revert me * CI: explicit command for spellchecker * spellcheck: edit misspells * CI: run spellcheck on diff * spellcheck: edits * spellcheck: edit misspells * spellcheck: add rules * spellcheck: mv configs * spellcheck: more edits * spellcheck: chore * spellcheck: one more thing * spellcheck: and another one * spellcheck: seems like it doesn't get to an end * spellcheck: new words after rebase * spellcheck: new words appearing out of nowhere * chore * review edits * more review edits * more edits * wonky behavior * wonky behavior 2 * wonky behavior 3 * change git behavior * spellcheck: another bunch of new edits * spellcheck: new words are koming out of nowhere * CI: finding the master * CI: fetching master implicitly * CI: undebug * new errors * a bunch of new edits * and some more * Update node/core/approval-voting/src/approval_db/v1/mod.rs Co-authored-by: Andronik Ordian <write@reusable.software> * Update xcm/xcm-executor/src/assets.rs Co-authored-by: Andronik Ordian <write@reusable.software> * Apply suggestions from code review Co-authored-by: Andronik Ordian <write@reusable.software> * Suggestions from the code review * CI: scan only changed files Co-authored-by: Andronik Ordian <write@reusable.software>
This commit is contained in:
@@ -427,7 +427,7 @@ pub struct AbridgedCandidateReceipt<H = Hash> {
|
||||
pub collator: CollatorId,
|
||||
/// Signature on blake2-256 of the block data by collator.
|
||||
pub signature: CollatorSignature,
|
||||
/// The hash of the pov-block.
|
||||
/// The hash of the `pov-block`.
|
||||
pub pov_block_hash: H,
|
||||
/// Commitments made as a result of validation.
|
||||
pub commitments: CandidateCommitments<H>,
|
||||
@@ -561,9 +561,9 @@ pub struct CandidateDescriptor<H = Hash> {
|
||||
/// The collator's relay-chain account ID
|
||||
pub collator: CollatorId,
|
||||
/// Signature on blake2-256 of components of this receipt:
|
||||
/// The para ID, the relay parent, and the pov_hash.
|
||||
/// The para ID, the relay parent, and the `pov_hash`.
|
||||
pub signature: CollatorSignature,
|
||||
/// The hash of the pov-block.
|
||||
/// The hash of the `pov-block`.
|
||||
pub pov_hash: H,
|
||||
}
|
||||
|
||||
@@ -582,12 +582,12 @@ pub struct CollationInfo {
|
||||
pub signature: CollatorSignature,
|
||||
/// The head-data
|
||||
pub head_data: HeadData,
|
||||
/// blake2-256 Hash of the pov-block
|
||||
/// blake2-256 Hash of the `pov-block`
|
||||
pub pov_block_hash: Hash,
|
||||
}
|
||||
|
||||
impl CollationInfo {
|
||||
/// Check integrity vs. a pov-block.
|
||||
/// Check integrity vs. a `pov-block`.
|
||||
pub fn check_signature(&self) -> Result<(), ()> {
|
||||
check_collator_signature(
|
||||
&self.relay_parent,
|
||||
|
||||
@@ -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/>.
|
||||
|
||||
//! V1 Primitives.
|
||||
//! `V1` Primitives.
|
||||
|
||||
use sp_std::prelude::*;
|
||||
use sp_std::collections::btree_map::BTreeMap;
|
||||
@@ -114,7 +114,7 @@ pub mod well_known_keys {
|
||||
})
|
||||
}
|
||||
|
||||
/// The hrmp channel for the given identifier.
|
||||
/// The HRMP channel for the given identifier.
|
||||
///
|
||||
/// The storage entry should be accessed as an `AbridgedHrmpChannel` encoded value.
|
||||
pub fn hrmp_channels(channel: HrmpChannelId) -> Vec<u8> {
|
||||
@@ -293,12 +293,12 @@ pub struct CandidateDescriptor<H = Hash> {
|
||||
/// relay-chain state which may vary based on bitfields included before the candidate.
|
||||
/// Thus it cannot be derived entirely from the relay-parent.
|
||||
pub persisted_validation_data_hash: Hash,
|
||||
/// The blake2-256 hash of the pov.
|
||||
/// The blake2-256 hash of the PoV.
|
||||
pub pov_hash: Hash,
|
||||
/// The root of a block's erasure encoding Merkle tree.
|
||||
pub erasure_root: Hash,
|
||||
/// Signature on blake2-256 of components of this receipt:
|
||||
/// The parachain index, the relay parent, the validation data hash, and the pov_hash.
|
||||
/// The parachain index, the relay parent, the validation data hash, and the `pov_hash`.
|
||||
pub signature: CollatorSignature,
|
||||
/// Hash of the para header that is being generated by this candidate.
|
||||
pub para_head: Hash,
|
||||
@@ -374,7 +374,7 @@ impl<H> CommittedCandidateReceipt<H> {
|
||||
}
|
||||
|
||||
impl<H: Clone> CommittedCandidateReceipt<H> {
|
||||
/// Transforms this into a plain CandidateReceipt.
|
||||
/// Transforms this into a plain `CandidateReceipt`.
|
||||
pub fn to_plain(&self) -> CandidateReceipt<H> {
|
||||
CandidateReceipt {
|
||||
descriptor: self.descriptor.clone(),
|
||||
@@ -642,7 +642,7 @@ impl GroupRotationInfo {
|
||||
/// Returns the index of the group needed to validate the core at the given index, assuming
|
||||
/// the given number of cores.
|
||||
///
|
||||
/// `core_index` should be less than `cores`, which is capped at u32::max().
|
||||
/// `core_index` should be less than `cores`, which is capped at `u32::max()`.
|
||||
pub fn group_for_core(&self, core_index: CoreIndex, cores: usize) -> GroupIndex {
|
||||
if self.group_rotation_frequency == 0 { return GroupIndex(core_index.0) }
|
||||
if cores == 0 { return GroupIndex(0) }
|
||||
@@ -660,7 +660,7 @@ impl GroupRotationInfo {
|
||||
/// Returns the index of the group assigned to the given core. This does no checking or
|
||||
/// whether the group index is in-bounds.
|
||||
///
|
||||
/// `core_index` should be less than `cores`, which is capped at u32::max().
|
||||
/// `core_index` should be less than `cores`, which is capped at `u32::max()`.
|
||||
pub fn core_for_group(&self, group_index: GroupIndex, cores: usize) -> CoreIndex {
|
||||
if self.group_rotation_frequency == 0 { return CoreIndex(group_index.0) }
|
||||
if cores == 0 { return CoreIndex(0) }
|
||||
@@ -844,7 +844,7 @@ pub struct SessionInfo {
|
||||
pub n_cores: u32,
|
||||
/// The zeroth delay tranche width.
|
||||
pub zeroth_delay_tranche_width: u32,
|
||||
/// The number of samples we do of relay_vrf_modulo.
|
||||
/// The number of samples we do of `relay_vrf_modulo`.
|
||||
pub relay_vrf_modulo_samples: u32,
|
||||
/// The number of delay tranches in total.
|
||||
pub n_delay_tranches: u32,
|
||||
@@ -886,7 +886,7 @@ sp_api::decl_runtime_apis! {
|
||||
/// Cores are either free or occupied. Free cores can have paras assigned to them.
|
||||
fn availability_cores() -> Vec<CoreState<H, N>>;
|
||||
|
||||
/// Yields the persisted validation data for the given ParaId along with an assumption that
|
||||
/// Yields the persisted validation data for the given `ParaId` along with an assumption that
|
||||
/// should be used if the para currently occupies a core.
|
||||
///
|
||||
/// Returns `None` if either the para is not registered or the assumption is `Freed`
|
||||
@@ -1029,7 +1029,7 @@ pub enum ConsensusLog {
|
||||
#[codec(index = 3)]
|
||||
ForceApprove(BlockNumber),
|
||||
/// A signal to revert the block number in the same chain as the
|
||||
/// header this digest is part of and all of its descendents.
|
||||
/// header this digest is part of and all of its descendants.
|
||||
///
|
||||
/// It is a no-op for a block to contain a revert digest targeting
|
||||
/// its own number or a higher number.
|
||||
|
||||
@@ -255,11 +255,11 @@ impl<Payload, RealPayload> From<Signed<Payload, RealPayload>> for UncheckedSigne
|
||||
}
|
||||
}
|
||||
|
||||
/// This helper trait ensures that we can encode Statement as CompactStatement,
|
||||
/// This helper trait ensures that we can encode `Statement` as `CompactStatement`,
|
||||
/// and anything as itself.
|
||||
///
|
||||
/// This resembles `parity_scale_codec::EncodeLike`, but it's distinct:
|
||||
/// EncodeLike is a marker trait which asserts at the typesystem level that
|
||||
/// `EncodeLike` is a marker trait which asserts at the typesystem level that
|
||||
/// one type's encoding is a valid encoding for another type. It doesn't
|
||||
/// perform any type conversion when encoding.
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user