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:
Dcompoze
2024-03-26 13:57:57 +00:00
committed by GitHub
parent b839c995c0
commit 002d9260f9
463 changed files with 1119 additions and 1017 deletions
@@ -303,11 +303,11 @@ pub fn take_storage_item<K: Encode + Sized, T: Decode + Sized, H: StorageHasher>
/// Move a storage from a pallet prefix to another pallet prefix.
///
/// Keys used in pallet storages always start with:
/// `concat(twox_128(pallet_name), towx_128(storage_name))`.
/// `concat(twox_128(pallet_name), twox_128(storage_name))`.
///
/// This function will remove all value for which the key start with
/// `concat(twox_128(old_pallet_name), towx_128(storage_name))` and insert them at the key with
/// the start replaced by `concat(twox_128(new_pallet_name), towx_128(storage_name))`.
/// `concat(twox_128(old_pallet_name), twox_128(storage_name))` and insert them at the key with
/// the start replaced by `concat(twox_128(new_pallet_name), twox_128(storage_name))`.
///
/// # Example
///
@@ -339,7 +339,7 @@ pub fn move_storage_from_pallet(
/// Move all storages from a pallet prefix to another pallet prefix.
///
/// Keys used in pallet storages always start with:
/// `concat(twox_128(pallet_name), towx_128(storage_name))`.
/// `concat(twox_128(pallet_name), twox_128(storage_name))`.
///
/// This function will remove all value for which the key start with `twox_128(old_pallet_name)`
/// and insert them at the key with the start replaced by `twox_128(new_pallet_name)`.
+11 -10
View File
@@ -159,7 +159,7 @@ pub trait StorageValue<T: FullCodec> {
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
fn decode_len() -> Option<usize>
where
@@ -363,7 +363,7 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
fn decode_len<KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<usize>
where
@@ -381,7 +381,8 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
///
/// # Warning
///
/// - `None` does not mean that `get()` does not return a value. The default value is completly
/// - `None` does not mean that `get()` does not return a value. The default value is
/// completely
/// ignored by this function.
///
/// - The value returned is the non-deduplicated length of the underlying Vector in storage.This
@@ -410,7 +411,7 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
pub trait IterableStorageMap<K: FullEncode, V: FullCodec>: StorageMap<K, V> {
/// The type that iterates over all `(key, value)`.
type Iterator: Iterator<Item = (K, V)>;
/// The type that itereates over all `key`s.
/// The type that iterates over all `key`s.
type KeyIterator: Iterator<Item = K>;
/// Enumerate all elements in the map in lexicographical order of the encoded key. If you
@@ -777,7 +778,7 @@ pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> {
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
fn decode_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where
@@ -798,7 +799,7 @@ pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> {
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
fn decode_non_dedup_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where
@@ -980,7 +981,7 @@ pub trait StorageNMap<K: KeyGenerator, V: FullCodec> {
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
fn decode_len<KArg: EncodeLikeTuple<K::KArg> + TupleToEncodedIter>(key: KArg) -> Option<usize>
where
@@ -1488,8 +1489,8 @@ pub trait StorageDecodeLength: private::Sealed + codec::DecodeLength {
}
}
/// It is expected that the length is at the beginning of the encoded objectand that the length is a
/// `Compact<u32>`.
/// It is expected that the length is at the beginning of the encoded object and that the length is
/// a `Compact<u32>`.
///
/// # Note
/// The length returned by this trait is not deduplicated, i.e. it is the length of the underlying
@@ -1790,7 +1791,7 @@ mod test {
});
}
// This test ensures that the Digest encoding does not change without being noticied.
// This test ensures that the Digest encoding does not change without being noticed.
#[test]
fn digest_storage_append_works_as_expected() {
TestExternalities::default().execute_with(|| {
@@ -217,7 +217,7 @@ const STORAGE_INPUT_BUFFER_CAPACITY: usize = 2 * 1024;
/// Implementation of [`codec::Input`] using [`sp_io::storage::read`].
///
/// Keeps an internal buffer with a size of [`STORAGE_INPUT_BUFFER_CAPACITY`]. All read accesses
/// are tried to be served by this buffer. If the buffer doesn't hold enough bytes to fullfill the
/// are tried to be served by this buffer. If the buffer doesn't hold enough bytes to fulfill the
/// current read access, the buffer is re-filled from the state. A read request that is bigger than
/// the internal buffer is directly forwarded to the state to reduce the number of reads from the
/// state.
@@ -310,7 +310,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Option<usize>
where
@@ -775,13 +775,13 @@ mod test {
assert_eq!(A::try_get(1), Err(()));
assert_eq!(A::count(), 3);
// Take exsisting.
// Take existing.
assert_eq!(A::take(4), 10);
assert_eq!(A::try_get(4), Err(()));
assert_eq!(A::count(), 2);
// Take non-exsisting.
// Take non-existing.
assert_eq!(A::take(4), ADefault::get());
assert_eq!(A::try_get(4), Err(()));
@@ -1022,13 +1022,13 @@ mod test {
assert_eq!(B::try_get(1), Err(()));
assert_eq!(B::count(), 3);
// Take exsisting.
// Take existing.
assert_eq!(B::take(4), Some(10));
assert_eq!(B::try_get(4), Err(()));
assert_eq!(B::count(), 2);
// Take non-exsisting.
// Take non-existing.
assert_eq!(B::take(4), None);
assert_eq!(B::try_get(4), Err(()));
@@ -378,7 +378,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len<KArg: EncodeLikeTuple<Key::KArg> + TupleToEncodedIter>(
key: KArg,
@@ -445,7 +445,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where
@@ -465,7 +465,8 @@ where
///
/// # Warning
///
/// - `None` does not mean that `get()` does not return a value. The default value is completly
/// - `None` does not mean that `get()` does not return a value. The default value is
/// completely
/// ignored by this function.
///
/// - The value returned is the non-deduplicated length of the underlying Vector in storage.This
@@ -277,7 +277,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Option<usize>
where
@@ -295,7 +295,8 @@ where
///
/// # Warning
///
/// - `None` does not mean that `get()` does not return a value. The default value is completly
/// - `None` does not mean that `get()` does not return a value. The default value is
/// completely
/// ignored by this function.
///
/// - The value returned is the non-deduplicated length of the underlying Vector in storage.This
@@ -195,7 +195,7 @@ mod test {
// result query returns error
assert_eq!(C::get(), Err(()));
// value query with custom onempty returns 42
// value query with custom on empty returns 42
assert_eq!(D::get(), 42);
});
}
@@ -348,7 +348,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len<KArg: EncodeLikeTuple<Key::KArg> + TupleToEncodedIter>(
key: KArg,
@@ -225,7 +225,7 @@ where
///
/// # Warning
///
/// `None` does not mean that `get()` does not return a value. The default value is completly
/// `None` does not mean that `get()` does not return a value. The default value is completely
/// ignored by this function.
pub fn decode_len() -> Option<usize>
where
@@ -243,7 +243,8 @@ where
///
/// # Warning
///
/// - `None` does not mean that `get()` does not return a value. The default value is completly
/// - `None` does not mean that `get()` does not return a value. The default value is
/// completely
/// ignored by this function.
///
/// - The value returned is the non-deduplicated length of the underlying Vector in storage.This