mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 09:17:58 +00:00
Fix spelling mistakes across the whole repository (#3808)
**Update:** Pushed additional changes based on the review comments. **This pull request fixes various spelling mistakes in this repository.** Most of the changes are contained in the first **3** commits: - `Fix spelling mistakes in comments and docs` - `Fix spelling mistakes in test names` - `Fix spelling mistakes in error messages, panic messages, logs and tracing` Other source code spelling mistakes are separated into individual commits for easier reviewing: - `Fix the spelling of 'authority'` - `Fix the spelling of 'REASONABLE_HEADERS_IN_JUSTIFICATION_ANCESTRY'` - `Fix the spelling of 'prev_enqueud_messages'` - `Fix the spelling of 'endpoint'` - `Fix the spelling of 'children'` - `Fix the spelling of 'PenpalSiblingSovereignAccount'` - `Fix the spelling of 'PenpalSudoAccount'` - `Fix the spelling of 'insufficient'` - `Fix the spelling of 'PalletXcmExtrinsicsBenchmark'` - `Fix the spelling of 'subtracted'` - `Fix the spelling of 'CandidatePendingAvailability'` - `Fix the spelling of 'exclusive'` - `Fix the spelling of 'until'` - `Fix the spelling of 'discriminator'` - `Fix the spelling of 'nonexistent'` - `Fix the spelling of 'subsystem'` - `Fix the spelling of 'indices'` - `Fix the spelling of 'committed'` - `Fix the spelling of 'topology'` - `Fix the spelling of 'response'` - `Fix the spelling of 'beneficiary'` - `Fix the spelling of 'formatted'` - `Fix the spelling of 'UNKNOWN_PROOF_REQUEST'` - `Fix the spelling of 'succeeded'` - `Fix the spelling of 'reopened'` - `Fix the spelling of 'proposer'` - `Fix the spelling of 'InstantiationNonce'` - `Fix the spelling of 'depositor'` - `Fix the spelling of 'expiration'` - `Fix the spelling of 'phantom'` - `Fix the spelling of 'AggregatedKeyValue'` - `Fix the spelling of 'randomness'` - `Fix the spelling of 'defendant'` - `Fix the spelling of 'AquaticMammal'` - `Fix the spelling of 'transactions'` - `Fix the spelling of 'PassingTracingSubscriber'` - `Fix the spelling of 'TxSignaturePayload'` - `Fix the spelling of 'versioning'` - `Fix the spelling of 'descendant'` - `Fix the spelling of 'overridden'` - `Fix the spelling of 'network'` Let me know if this structure is adequate. **Note:** The usage of the words `Merkle`, `Merkelize`, `Merklization`, `Merkelization`, `Merkleization`, is somewhat inconsistent but I left it as it is. ~~**Note:** In some places the term `Receival` is used to refer to message reception, IMO `Reception` is the correct word here, but I left it as it is.~~ ~~**Note:** In some places the term `Overlayed` is used instead of the more acceptable version `Overlaid` but I also left it as it is.~~ ~~**Note:** In some places the term `Applyable` is used instead of the correct version `Applicable` but I also left it as it is.~~ **Note:** Some usage of British vs American english e.g. `judgement` vs `judgment`, `initialise` vs `initialize`, `optimise` vs `optimize` etc. are both present in different places, but I suppose that's understandable given the number of contributors. ~~**Note:** There is a spelling mistake in `.github/CODEOWNERS` but it triggers errors in CI when I make changes to it, so I left it as it is.~~
This commit is contained in:
@@ -249,7 +249,7 @@ impl BenchmarkCallDef {
|
||||
}
|
||||
}
|
||||
|
||||
/// Represents a parsed `#[benchmark]` or `#[instance_banchmark]` item.
|
||||
/// Represents a parsed `#[benchmark]` or `#[instance_benchmark]` item.
|
||||
#[derive(Clone)]
|
||||
struct BenchmarkDef {
|
||||
params: Vec<ParamDef>,
|
||||
@@ -466,7 +466,7 @@ pub fn benchmarks(
|
||||
let mod_vis = module.vis;
|
||||
let mod_name = module.ident;
|
||||
|
||||
// consume #[benchmarks] attribute by exclusing it from mod_attrs
|
||||
// consume #[benchmarks] attribute by excluding it from mod_attrs
|
||||
let mod_attrs: Vec<&Attribute> = module
|
||||
.attrs
|
||||
.iter()
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
//! - Implicitly: `System: frame_system`
|
||||
//! - Explicitly: `System: frame_system::{Pallet, Call}`
|
||||
//!
|
||||
//! The `construct_runtime` transitions from the implicit definition to the explict one.
|
||||
//! The `construct_runtime` transitions from the implicit definition to the explicit one.
|
||||
//! From the explicit state, Substrate expands the pallets with additional information
|
||||
//! that is to be included in the runtime metadata. This expansion makes visible some extra
|
||||
//! parts of the pallets, mainly the `Error` if defined. The expanded state looks like
|
||||
@@ -55,7 +55,7 @@
|
||||
//! +----------+ +------------------+
|
||||
//! ```
|
||||
//!
|
||||
//! When all pallet parts are implcit, then the `construct_runtime!` macro expands to its final
|
||||
//! When all pallet parts are implicit, then the `construct_runtime!` macro expands to its final
|
||||
//! state, the `ExplicitExpanded`. Otherwise, all implicit parts are converted to an explicit
|
||||
//! expanded part allow the `construct_runtime!` to expand any remaining explicit parts to an
|
||||
//! explicit expanded part.
|
||||
@@ -202,7 +202,7 @@
|
||||
//! Similarly to the previous transition, the macro expansion transforms `System:
|
||||
//! frame_system::{Pallet, Call}` into `System: frame_system expanded::{Error} ::{Pallet, Call}`.
|
||||
//! The `expanded` section adds extra parts that the Substrate would like to expose for each pallet
|
||||
//! by default. This is done to expose the approprite types for metadata construction.
|
||||
//! by default. This is done to expose the appropriate types for metadata construction.
|
||||
//!
|
||||
//! This time, instead of calling `tt_default_parts` we are using the `tt_extra_parts` macro.
|
||||
//! This macro returns the ` :: expanded { Error }` list of additional parts we would like to
|
||||
|
||||
@@ -322,7 +322,7 @@ impl Parse for PalletDeclaration {
|
||||
/// A struct representing a path to a pallet. `PalletPath` is almost identical to the standard
|
||||
/// Rust path with a few restrictions:
|
||||
/// - No leading colons allowed
|
||||
/// - Path segments can only consist of identifers separated by colons
|
||||
/// - Path segments can only consist of identifiers separated by colons
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct PalletPath {
|
||||
pub inner: Path,
|
||||
@@ -595,7 +595,7 @@ pub struct Pallet {
|
||||
pub is_expanded: bool,
|
||||
/// The name of the pallet, e.g.`System` in `System: frame_system`.
|
||||
pub name: Ident,
|
||||
/// Either automatically infered, or defined (e.g. `MyPallet ... = 3,`).
|
||||
/// Either automatically inferred, or defined (e.g. `MyPallet ... = 3,`).
|
||||
pub index: u8,
|
||||
/// The path of the pallet, e.g. `frame_system` in `System: frame_system`.
|
||||
pub path: PalletPath,
|
||||
@@ -634,7 +634,7 @@ impl Pallet {
|
||||
/// +----------+ +----------+ +------------------+
|
||||
/// ```
|
||||
enum PalletsConversion {
|
||||
/// Pallets implicitely declare parts.
|
||||
/// Pallets implicitly declare parts.
|
||||
///
|
||||
/// `System: frame_system`.
|
||||
Implicit(Vec<PalletDeclaration>),
|
||||
@@ -648,7 +648,7 @@ enum PalletsConversion {
|
||||
/// Pallets explicitly declare parts that are fully expanded.
|
||||
///
|
||||
/// This is the end state that contains extra parts included by
|
||||
/// default by Subtrate.
|
||||
/// default by Substrate.
|
||||
///
|
||||
/// `System: frame_system expanded::{Error} ::{Pallet, Call}`
|
||||
///
|
||||
@@ -660,7 +660,7 @@ enum PalletsConversion {
|
||||
///
|
||||
/// Check if all pallet have explicit declaration of their parts, if so then assign index to each
|
||||
/// pallet using same rules as rust for fieldless enum. I.e. implicit are assigned number
|
||||
/// incrementedly from last explicit or 0.
|
||||
/// incrementally from last explicit or 0.
|
||||
fn convert_pallets(pallets: Vec<PalletDeclaration>) -> syn::Result<PalletsConversion> {
|
||||
if pallets.iter().any(|pallet| pallet.pallet_parts.is_none()) {
|
||||
return Ok(PalletsConversion::Implicit(pallets))
|
||||
|
||||
@@ -279,7 +279,7 @@ fn test_runtime_type_with_doc() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_disambugation_path() {
|
||||
fn test_disambiguation_path() {
|
||||
let foreign_impl: ItemImpl = parse_quote!(impl SomeTrait for SomeType {});
|
||||
let default_impl_path: Path = parse_quote!(SomeScope::SomeType);
|
||||
|
||||
|
||||
@@ -147,8 +147,8 @@ fn ensure_codec_index(attrs: &Vec<syn::Attribute>, span: Span) -> Result<()> {
|
||||
|
||||
/// Used to inject arguments into the inner `#[dynamic_pallet_params(..)]` attribute.
|
||||
///
|
||||
/// This allows the outer `#[dynamic_params(..)]` attribute to specify some arguments that dont need
|
||||
/// to be repeated every time.
|
||||
/// This allows the outer `#[dynamic_params(..)]` attribute to specify some arguments that don't
|
||||
/// need to be repeated every time.
|
||||
struct MacroInjectArgs {
|
||||
runtime_params: syn::Ident,
|
||||
params_pallet: syn::Type,
|
||||
@@ -311,7 +311,7 @@ impl ToTokens for DynamicPalletParamAttr {
|
||||
)*
|
||||
}
|
||||
|
||||
impl #scrate::traits::dynamic_params::AggregratedKeyValue for Parameters {
|
||||
impl #scrate::traits::dynamic_params::AggregatedKeyValue for Parameters {
|
||||
type Key = #key_ident;
|
||||
type Value = #value_ident;
|
||||
|
||||
@@ -497,7 +497,7 @@ impl ToTokens for DynamicParamAggregatedEnum {
|
||||
#vis enum #params_key_ident {
|
||||
#(
|
||||
#(#attributes)*
|
||||
#param_names(<#param_types as #scrate::traits::dynamic_params::AggregratedKeyValue>::Key),
|
||||
#param_names(<#param_types as #scrate::traits::dynamic_params::AggregatedKeyValue>::Key),
|
||||
)*
|
||||
}
|
||||
|
||||
@@ -515,11 +515,11 @@ impl ToTokens for DynamicParamAggregatedEnum {
|
||||
#vis enum #params_value_ident {
|
||||
#(
|
||||
#(#attributes)*
|
||||
#param_names(<#param_types as #scrate::traits::dynamic_params::AggregratedKeyValue>::Value),
|
||||
#param_names(<#param_types as #scrate::traits::dynamic_params::AggregatedKeyValue>::Value),
|
||||
)*
|
||||
}
|
||||
|
||||
impl #scrate::traits::dynamic_params::AggregratedKeyValue for #name {
|
||||
impl #scrate::traits::dynamic_params::AggregatedKeyValue for #name {
|
||||
type Key = #params_key_ident;
|
||||
type Value = #params_value_ident;
|
||||
|
||||
@@ -536,13 +536,13 @@ impl ToTokens for DynamicParamAggregatedEnum {
|
||||
}
|
||||
|
||||
#(
|
||||
impl ::core::convert::From<<#param_types as #scrate::traits::dynamic_params::AggregratedKeyValue>::Key> for #params_key_ident {
|
||||
fn from(key: <#param_types as #scrate::traits::dynamic_params::AggregratedKeyValue>::Key) -> Self {
|
||||
impl ::core::convert::From<<#param_types as #scrate::traits::dynamic_params::AggregatedKeyValue>::Key> for #params_key_ident {
|
||||
fn from(key: <#param_types as #scrate::traits::dynamic_params::AggregatedKeyValue>::Key) -> Self {
|
||||
#params_key_ident::#param_names(key)
|
||||
}
|
||||
}
|
||||
|
||||
impl ::core::convert::TryFrom<#params_value_ident> for <#param_types as #scrate::traits::dynamic_params::AggregratedKeyValue>::Value {
|
||||
impl ::core::convert::TryFrom<#params_value_ident> for <#param_types as #scrate::traits::dynamic_params::AggregatedKeyValue>::Value {
|
||||
type Error = ();
|
||||
|
||||
fn try_from(value: #params_value_ident) -> Result<Self, Self::Error> {
|
||||
|
||||
@@ -137,7 +137,7 @@ fn counter_prefix(prefix: &str) -> String {
|
||||
/// - `Call` - If the pallet has callable functions
|
||||
/// - `Storage` - If the pallet uses storage
|
||||
/// - `Event` or `Event<T>` (if the event is generic) - If the pallet emits events
|
||||
/// - `Origin` or `Origin<T>` (if the origin is generic) - If the pallet has instanciable origins
|
||||
/// - `Origin` or `Origin<T>` (if the origin is generic) - If the pallet has instantiable origins
|
||||
/// - `Config` or `Config<T>` (if the config is generic) - If the pallet builds the genesis
|
||||
/// storage with `GenesisConfig`
|
||||
/// - `Inherent` - If the pallet provides/can check inherents.
|
||||
@@ -166,7 +166,7 @@ fn counter_prefix(prefix: &str) -> String {
|
||||
/// and `Event` are encoded, and to define the ModuleToIndex value.
|
||||
///
|
||||
/// if `= $n` is not given, then index is resolved in the same way as fieldless enum in Rust
|
||||
/// (i.e. incrementedly from previous index):
|
||||
/// (i.e. incrementally from previous index):
|
||||
/// ```nocompile
|
||||
/// pallet1 .. = 2,
|
||||
/// pallet2 .., // Here pallet2 is given index 3
|
||||
@@ -460,7 +460,7 @@ pub fn storage_alias(attributes: TokenStream, input: TokenStream) -> TokenStream
|
||||
}
|
||||
|
||||
/// This attribute can be used to derive a full implementation of a trait based on a local partial
|
||||
/// impl and an external impl containing defaults that can be overriden in the local impl.
|
||||
/// impl and an external impl containing defaults that can be overridden in the local impl.
|
||||
///
|
||||
/// For a full end-to-end example, see [below](#use-case-auto-derive-test-pallet-config-traits).
|
||||
///
|
||||
|
||||
@@ -321,7 +321,7 @@ impl Def {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Tries to locate a manual tasks impl (an impl impling a trait whose last path segment is
|
||||
/// Tries to locate a manual tasks impl (an impl implementing a trait whose last path segment is
|
||||
/// `Task`) in the event that one has not been found already via the attribute macro
|
||||
pub fn resolve_manual_tasks_impl(
|
||||
tasks: &mut Option<tasks::TasksDef>,
|
||||
|
||||
Reference in New Issue
Block a user