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>

polkadot/node/test/client/src/block_builder.rs

@@ -24,7 +24,7 @@ use sc_block_builder::{BlockBuilderProvider, BlockBuilder};
 use sp_state_machine::BasicExternalities;
 use parity_scale_codec::{Encode, Decode};
 
-/// An extension for the test client to init a Polkadot specific block builder.
+/// An extension for the test client to initialize a Polkadot specific block builder.
 pub trait InitPolkadotBlockBuilder {
 	/// Init a Polkadot specific block builder that works for the test runtime.
 	///

polkadot/node/test/client/src/lib.rs

@@ -38,7 +38,7 @@ pub type Executor = client::LocalCallExecutor<Block, FullBackend, sc_executor::N
 /// Test client builder for Polkadot.
 pub type TestClientBuilder = substrate_test_client::TestClientBuilder<Block, Executor, FullBackend, GenesisParameters>;
 
-/// LongestChain type for the test runtime/client.
+/// `LongestChain` type for the test runtime/client.
 pub type LongestChain = sc_consensus::LongestChain<FullBackend, Block>;
 
 /// Parameters of test-client builder with test-runtime.

polkadot/node/test/polkadot-simnet/common/src/lib.rs

@@ -47,7 +47,7 @@ sc_executor::native_executor_instance!(
 	(benchmarking::benchmarking::HostFunctions, SignatureVerificationOverride),
 );
 
-/// ChainInfo implementation.
+/// `ChainInfo` implementation.
 pub struct PolkadotChainInfo;
 
 impl ChainInfo for PolkadotChainInfo {

polkadot/node/test/polkadot-simnet/node/src/main.rs

@@ -14,8 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
-//! Binary used for simnet nodes, supports all runtimes, although only polkadot is implemented currently.
-//! This binary accepts all the cli args the polkadot binary does, Only difference is it uses
+//! Binary used for Simnet nodes, supports all runtimes, although only polkadot is implemented currently.
+//! This binary accepts all the CLI args the polkadot binary does, Only difference is it uses
 //! manual-seal™ and babe for block authorship, it has a no-op verifier, so all blocks received over the network
 //! are imported and executed straight away. Block authorship/Finalization maybe done by calling the
 //!  `engine_createBlock` & `engine_FinalizeBlock` rpc methods respectively.

polkadot/node/test/polkadot-simnet/test/src/main.rs

@@ -13,7 +13,7 @@
 
 // You should have received a copy of the GNU General Public License
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
-//! Attempts to upgrade the polkadot runtime, in a simnet environment
+//! Attempts to upgrade the polkadot runtime, in a Simnet environment
 use std::{error::Error, str::FromStr};
 
 use polkadot_simnet::{run, dispatch_with_root};

polkadot/node/test/service/src/chain_spec.rs

@@ -92,7 +92,7 @@ fn testnet_accounts() -> Vec<AccountId> {
 	]
 }
 
-/// Helper function to create polkadot GenesisConfig for testing
+/// Helper function to create polkadot `GenesisConfig` for testing
 fn polkadot_testnet_genesis(
 	initial_authorities: Vec<(
 		AccountId,

polkadot/node/test/service/src/lib.rs

@@ -285,7 +285,7 @@ pub fn run_collator_node(
 
 /// A Polkadot test node instance used for testing.
 pub struct PolkadotTestNode {
-	/// TaskManager's instance.
+	/// `TaskManager`'s instance.
 	pub task_manager: TaskManager,
 	/// Client's instance.
 	pub client: Arc<Client>,
@@ -293,7 +293,7 @@ pub struct PolkadotTestNode {
 	pub overseer_handler: Handle,
 	/// The `MultiaddrWithPeerId` to this node. This is useful if you want to pass it as "boot node" to other nodes.
 	pub addr: MultiaddrWithPeerId,
-	/// RPCHandlers to make RPC queries.
+	/// `RPCHandlers` to make RPC queries.
 	pub rpc_handlers: RpcHandlers,
 }