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>

utils/staking-miner/src/signer.rs

@@ -32,7 +32,7 @@ pub(crate) struct Signer {
 	pub(crate) account: AccountId,
 	/// The full crypto key-pair.
 	pub(crate) pair: Pair,
-	/// The raw uri read from file.
+	/// The raw URI read from file.
 	pub(crate) uri: String,
 }
 
@@ -51,7 +51,7 @@ pub(crate) async fn get_account_info<T: frame_system::Config>(
 	.await
 }
 
-/// Read the signer account's uri from the given `path`.
+/// Read the signer account's URI from the given `path`.
 pub(crate) async fn read_signer_uri<
 	P: AsRef<Path>,
 	T: frame_system::Config<AccountId = AccountId, Index = Index>,

xcm/src/lib.rs

@@ -48,7 +48,7 @@ pub mod opaque {
 		pub use crate::v0::opaque::{Xcm, Order};
 	}
 
-	/// The basic VersionedXcm type which just uses the `Vec<u8>` as an encoded call.
+	/// The basic `VersionedXcm` type which just uses the `Vec<u8>` as an encoded call.
 	pub type VersionedXcm = super::VersionedXcm<()>;
 }
 

xcm/src/v0/junction.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
-//! Support datastructures for `MultiLocation`, primarily the `Junction` datatype.
+//! Support data structures for `MultiLocation`, primarily the `Junction` datatype.
 
 use alloc::vec::Vec;
 use parity_scale_codec::{self, Encode, Decode};

xcm/src/v0/mod.rs

@@ -171,7 +171,7 @@ pub enum Xcm<Call> {
 	/// - `assets`: The asset(s) to be withdrawn.
 	/// - `dest`: The new owner for the assets.
 	/// - `effects`: The orders that should be contained in the `ReserveAssetDeposit` which is sent onwards to
-	///   `dest.
+	///   `dest`.
 	///
 	/// Safety: No concerns.
 	///

xcm/src/v0/multi_asset.rs

@@ -28,7 +28,7 @@ pub enum AssetInstance {
 	/// Undefined - used if the NFA class has only one instance.
 	Undefined,
 
-	/// A compact index. Technically this could be greater than u128, but this implementation supports only
+	/// A compact index. Technically this could be greater than `u128`, but this implementation supports only
 	/// values up to `2**128 - 1`.
 	Index { #[codec(compact)] id: u128 },
 

xcm/src/v0/multi_location.rs

@@ -66,7 +66,7 @@ pub enum MultiLocation {
 	X8(Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction),
 }
 
-/// Maximum number of junctions a multilocation can contain.
+/// Maximum number of junctions a `MultiLocation` can contain.
 pub const MAX_MULTILOCATION_LENGTH: usize = 8;
 
 impl From<Junction> for MultiLocation {

xcm/src/v0/order.rs

@@ -49,7 +49,7 @@ pub enum Order<Call> {
 	/// - `assets`: The asset(s) to remove from holding.
 	/// - `dest`: The new owner for the assets.
 	/// - `effects`: The orders that should be contained in the `ReserveAssetDeposit` which is sent onwards to
-	///   `dest.
+	///   `dest`.
 	///
 	/// Errors:
 	#[codec(index = 2)]
@@ -101,7 +101,7 @@ pub enum Order<Call> {
 	#[codec(index = 6)]
 	QueryHolding { #[codec(compact)] query_id: u64, dest: MultiLocation, assets: Vec<MultiAsset> },
 
-	/// Pay for the execution of some Xcm with up to `weight` picoseconds of execution time, paying for this with
+	/// Pay for the execution of some XCM with up to `weight` picoseconds of execution time, paying for this with
 	/// up to `fees` from the holding account.
 	///
 	/// Errors:

xcm/src/v0/traits.rs

@@ -171,7 +171,7 @@ impl<C> ExecuteXcm<C> for () {
 ///
 /// These can be amalgamated in tuples to form sophisticated routing systems. In tuple format, each router might return
 /// `CannotReachDestination` to pass the execution to the next sender item. Note that each `CannotReachDestination`
-/// might alter the destination and the xcm message for to the next router.
+/// might alter the destination and the XCM message for to the next router.
 ///
 ///
 /// # Example

xcm/xcm-builder/src/filter_asset_location.rs

@@ -21,7 +21,7 @@ use xcm::v0::{MultiAsset, MultiLocation};
 use frame_support::traits::Get;
 use xcm_executor::traits::FilterAssetLocation;
 
-/// Accepts an asset IFF it is a native asset.
+/// Accepts an asset iff it is a native asset.
 pub struct NativeAsset;
 impl FilterAssetLocation for NativeAsset {
 	fn filter_asset_location(asset: &MultiAsset, origin: &MultiLocation) -> bool {
@@ -29,7 +29,7 @@ impl FilterAssetLocation for NativeAsset {
 	}
 }
 
-/// Accepts an asset if it is contained in the given `T`'s `Get` impl.
+/// Accepts an asset if it is contained in the given `T`'s `Get` implementation.
 pub struct Case<T>(PhantomData<T>);
 impl<T: Get<(MultiAsset, MultiLocation)>> FilterAssetLocation for Case<T> {
 	fn filter_asset_location(asset: &MultiAsset, origin: &MultiLocation) -> bool {

xcm/xcm-builder/src/fungibles_adapter.rs

@@ -21,7 +21,7 @@ use xcm::v0::{Error as XcmError, Result, MultiAsset, MultiLocation, Junction};
 use frame_support::traits::{Get, tokens::fungibles, Contains};
 use xcm_executor::traits::{TransactAsset, Convert, MatchesFungibles, Error as MatchError};
 
-/// Converter struct implementing `AssetIdConversion` converting a numeric asset ID (must be TryFrom/TryInto<u128>) into
+/// Converter struct implementing `AssetIdConversion` converting a numeric asset ID (must be `TryFrom/TryInto<u128>`) into
 /// a `GeneralIndex` junction, prefixed by some `MultiLocation` value. The `MultiLocation` value will typically be a
 /// `PalletInstance` junction.
 pub struct AsPrefixedGeneralIndex<Prefix, AssetId, ConvertAssetId>(PhantomData<(Prefix, AssetId, ConvertAssetId)>);

xcm/xcm-builder/src/origin_conversion.rs

@@ -172,7 +172,7 @@ impl<
 	}
 }
 
-/// EnsureOrigin barrier to convert from dispatch origin to XCM origin, if one exists.
+/// `EnsureOrigin` barrier to convert from dispatch origin to XCM origin, if one exists.
 pub struct EnsureXcmOrigin<Origin, Conversion>(PhantomData<(Origin, Conversion)>);
 impl<
 	Origin: OriginTrait + Clone,
@@ -227,7 +227,7 @@ impl<
 }
 
 /// `Convert` implementation to convert from some an origin which implements `Backing` into a corresponding `Plurality`
-/// MultiLocation.
+/// `MultiLocation`.
 ///
 /// Typically used when configuring `pallet-xcm` for allowing a collective's Origin to dispatch an XCM from a
 /// `Plurality` origin.

xcm/xcm-builder/src/weight.rs

@@ -128,7 +128,7 @@ impl<T: Get<(MultiLocation, u128)>, R: TakeRevenue> Drop for FixedRateOfConcrete
 	}
 }
 
-/// Weight trader which uses the TransactionPayment pallet to set the right price for weight and then
+/// Weight trader which uses the `TransactionPayment` pallet to set the right price for weight and then
 /// places any weight bought into the right account.
 pub struct UsingComponents<
 	WeightToFee: WeightToFeePolynomial<Balance=Currency::Balance>,

xcm/xcm-executor/src/assets.rs

@@ -26,7 +26,7 @@ pub enum AssetId {
 }
 
 impl AssetId {
-	/// Prepend a MultiLocation to a concrete asset, giving it a new root location.
+	/// Prepend a `MultiLocation` to a concrete asset, giving it a new root location.
 	pub fn prepend_location(&mut self, prepend: &MultiLocation) -> Result<(), ()> {
 		if let AssetId::Concrete(ref mut l) = self {
 			l.prepend_with(prepend.clone()).map_err(|_| ())?;

xcm/xcm-executor/src/config.rs

@@ -22,7 +22,7 @@ use crate::traits::{
 	OnResponse,
 };
 
-/// The trait to parametrize the `XcmExecutor`.
+/// The trait to parameterize the `XcmExecutor`.
 pub trait Config {
 	/// The outer call dispatch type.
 	type Call: Parameter + Dispatchable<PostInfo=PostDispatchInfo> + GetDispatchInfo;

xcm/xcm-executor/src/traits/conversion.rs

@@ -19,7 +19,7 @@ use parity_scale_codec::{Encode, Decode};
 use xcm::v0::{MultiLocation, OriginKind};
 
 /// Generic third-party conversion trait. Use this when you don't want to force the user to use default
-/// impls of `From` and `Into` for the types you wish to convert between.
+/// implementations of `From` and `Into` for the types you wish to convert between.
 ///
 /// One of `convert`/`convert_ref` and `reverse`/`reverse_ref` MUST be implemented. If possible, implement
 /// `convert_ref`, since this will never result in a clone. Use `convert` when you definitely need to consume
@@ -118,7 +118,7 @@ impl<T: Clone + Encode + Decode> Convert<Vec<u8>, T> for Decoded {
 	fn reverse_ref(value: impl Borrow<T>) -> Result<Vec<u8>, ()> { Ok(value.borrow().encode()) }
 }
 
-/// A convertor trait for origin types.
+/// A converter `trait` for origin types.
 ///
 /// Can be amalgamated into tuples. If any of the tuple elements returns `Ok(_)`, it short circuits. Else, the `Err(_)`
 /// of the last tuple item is returned. Each intermediate `Err(_)` might return a different `origin` of type `Origin`

xcm/xcm-executor/src/traits/should_execute.rs

@@ -31,7 +31,7 @@ pub trait ShouldExecute {
 	/// - `message`: The message itself.
 	/// - `shallow_weight`: The weight of the non-negotiable execution of the message. This does not include any
 	///   embedded XCMs sat behind mechanisms like `BuyExecution` which would need to answer for their own weight.
-	/// - `weight_credit`: The pre-established amount of weight that the system has determined this message may utilise
+	/// - `weight_credit`: The pre-established amount of weight that the system has determined this message may utilize
 	///   in its execution. Typically non-zero only because of prior fee payment, but could in principle be due to other
 	///   factors.
 	fn should_execute<Call>(

xcm/xcm-executor/src/traits/transact_asset.rs

@@ -44,7 +44,7 @@ pub trait TransactAsset {
 	/// not be needed if the teleporting chains are to be trusted, but better to be safe than sorry). On chains
 	/// where the asset is not native then it will generally just be a no-op.
 	///
-	/// When composed as a tuple, all type-items are called. It is up to the implementor that there exists no
+	/// When composed as a tuple, all type-items are called. It is up to the implementer that there exists no
 	/// value for `_what` which can cause side-effects for more than one of the type-items.
 	fn check_in(_origin: &MultiLocation, _what: &MultiAsset) {}
 
@@ -56,7 +56,7 @@ pub trait TransactAsset {
 	/// be needed if the teleporting chains are to be trusted, but better to be safe than sorry). On chains where
 	/// the asset is not native then it will generally just be a no-op.
 	///
-	/// When composed as a tuple, all type-items are called. It is up to the implementor that there exists no
+	/// When composed as a tuple, all type-items are called. It is up to the implementer that there exists no
 	/// value for `_what` which can cause side-effects for more than one of the type-items.
 	fn check_out(_origin: &MultiLocation, _what: &MultiAsset) {}
 

xcm/xcm-executor/src/traits/weight.rs

@@ -41,7 +41,7 @@ pub trait WeightBounds<Call> {
 	///
 	/// This is guaranteed equal to the eventual sum of all `shallow` XCM messages that get executed through
 	/// any internal effects. Inner XCM messages may be executed by:
-	/// - Order::BuyExecution
+	/// - `Order::BuyExecution`
 	fn deep(message: &mut Xcm<Call>) -> Result<Weight, ()>;
 
 	/// Return the total weight for executing `message`.