Unverified Commit 9b7b92c1 authored by Michael Müller's avatar Michael Müller Committed by GitHub
Browse files

Enable `spellcheck` CI stage (#822)

* Enable `spellcheck` CI job

* Fix spellchecking mistakes

* Implement review suggestion

* Reword `>= 2`
parent e1486563
Pipeline #142848 passed with stages
in 29 minutes and 17 seconds
...@@ -126,7 +126,7 @@ impl BitStash { ...@@ -126,7 +126,7 @@ impl BitStash {
.set(); .set();
index as u32 + first_zero as u32 index as u32 + first_zero as u32
} else { } else {
// We found a free storage slot but it isn't within the valid // We found a free storage slot but it is not within the valid
// bounds of the free list but points to its end. So we simply // bounds of the free list but points to its end. So we simply
// append another 1 bit (`true`) to the free list and return // append another 1 bit (`true`) to the free list and return
// a new index pointing to it. No need to push to the counts // a new index pointing to it. No need to push to the counts
......
...@@ -37,7 +37,7 @@ use ink_primitives::Key; ...@@ -37,7 +37,7 @@ use ink_primitives::Key;
/// ///
/// # Note /// # Note
/// ///
/// Use this if the storage field doesn't need to be loaded in some or most cases. /// Use this if the storage field does not need to be loaded in some or most cases.
pub struct LazyCell<T> pub struct LazyCell<T>
where where
T: SpreadLayout, T: SpreadLayout,
......
...@@ -59,7 +59,7 @@ use ink_primitives::Key; ...@@ -59,7 +59,7 @@ use ink_primitives::Key;
/// ///
/// # Note /// # Note
/// ///
/// Use this if the storage field doesn't need to be loaded in some or most cases. /// Use this if the storage field does not need to be loaded in some or most cases.
#[derive(Debug)] #[derive(Debug)]
pub struct Lazy<T> pub struct Lazy<T>
where where
......
...@@ -45,7 +45,7 @@ where ...@@ -45,7 +45,7 @@ where
Some(value) => { Some(value) => {
// Handle the Option<T> as if it was a T. // Handle the Option<T> as if it was a T.
// //
// Sadly this doesn't not work well with `Option<Option<T>>`. // Sadly this does not not work well with `Option<Option<T>>`.
// For this we'd need specialization in Rust or similar. // For this we'd need specialization in Rust or similar.
super::push_spread_root(value, root_key) super::push_spread_root(value, root_key)
} }
...@@ -123,7 +123,7 @@ where ...@@ -123,7 +123,7 @@ where
Some(value) => { Some(value) => {
// Handle the Option<T> as if it was a T. // Handle the Option<T> as if it was a T.
// //
// Sadly this doesn't not work well with `Option<Option<T>>`. // Sadly this does not work well with `Option<Option<T>>`.
// For this we'd need specialization in Rust or similar. // For this we'd need specialization in Rust or similar.
super::push_packed_root(value, root_key) super::push_packed_root(value, root_key)
} }
......
...@@ -29,9 +29,9 @@ mod delegator { ...@@ -29,9 +29,9 @@ mod delegator {
}; };
use subber::Subber; use subber::Subber;
/// Specifies the state of the delegator. /// Specifies the state of the `delegator` contract.
/// ///
/// In `Adder` state the delegator will delegate to the `Adder` contract /// In `Adder` state the `delegator` contract will delegate to the `Adder` contract
/// and in `Subber` state will delegate to the `Subber` contract. /// and in `Subber` state will delegate to the `Subber` contract.
/// ///
/// The initial state is `Adder`. /// The initial state is `Adder`.
...@@ -58,11 +58,11 @@ mod delegator { ...@@ -58,11 +58,11 @@ mod delegator {
/// Delegates calls to an `adder` or `subber` contract to mutate /// Delegates calls to an `adder` or `subber` contract to mutate
/// a value in an `accumulator` contract. /// a value in an `accumulator` contract.
/// ///
/// In order to deploy the delegator smart contract we first /// In order to deploy the `delegator` smart contract we first
/// have to manually put the code of the `accumulator`, `adder` /// have to manually put the code of the `accumulator`, `adder`
/// and `subber` smart contracts, receive their code hashes from /// and `subber` smart contracts, receive their code hashes from
/// the signalled events and put their code hash into our /// the signalled events and put their code hash into our
/// delegator smart contract. /// `delegator` smart contract.
#[ink(storage)] #[ink(storage)]
pub struct Delegator { pub struct Delegator {
/// Says which of `adder` or `subber` is currently in use. /// Says which of `adder` or `subber` is currently in use.
...@@ -76,7 +76,7 @@ mod delegator { ...@@ -76,7 +76,7 @@ mod delegator {
} }
impl Delegator { impl Delegator {
/// Instantiate a delegator with the given sub-contract codes. /// Instantiate a `delegator` contract with the given sub-contract codes.
#[ink(constructor)] #[ink(constructor)]
pub fn new( pub fn new(
init_value: i32, init_value: i32,
...@@ -128,7 +128,7 @@ mod delegator { ...@@ -128,7 +128,7 @@ mod delegator {
} }
} }
/// Switches the delegator. /// Switches the `delegator` contract.
#[ink(message)] #[ink(message)]
pub fn switch(&mut self) { pub fn switch(&mut self) {
match self.which { match self.which {
......
...@@ -58,8 +58,8 @@ mod dns { ...@@ -58,8 +58,8 @@ mod dns {
new_owner: AccountId, new_owner: AccountId,
} }
/// Domain name service contract inspired by ChainX's /// Domain name service contract inspired by
/// [blog post](https://medium.com/@chainx_org/secure-and-decentralized-polkadot-domain-name-system-e06c35c2a48d). /// [this blog post](https://medium.com/@chainx_org/secure-and-decentralized-polkadot-domain-name-system-e06c35c2a48d).
/// ///
/// # Note /// # Note
/// ///
......
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
//! //!
//! ## Interface //! ## Interface
//! //!
//! The interface is modelled after the popular gnosis multisig wallet. However, there //! The interface is modelled after the popular Gnosis multisig wallet. However, there
//! are subtle variations from the interface. For example the `confirm_transaction` //! are subtle variations from the interface. For example the `confirm_transaction`
//! will never trigger the execution of a `Transaction` even if the threshold is reached. //! will never trigger the execution of a `Transaction` even if the threshold is reached.
//! A call of `execute_transaction` is always required. This can be called by anyone. //! A call of `execute_transaction` is always required. This can be called by anyone.
...@@ -107,7 +107,7 @@ mod multisig_plain { ...@@ -107,7 +107,7 @@ mod multisig_plain {
/// A wrapper that allows us to encode a blob of bytes. /// A wrapper that allows us to encode a blob of bytes.
/// ///
/// We use this to pass the set of not typed (bytes) parameters to the `CallBuilder`. /// We use this to pass the set of untyped (bytes) parameters to the `CallBuilder`.
struct CallInput<'a>(&'a [u8]); struct CallInput<'a>(&'a [u8]);
impl<'a> scale::Encode for CallInput<'a> { impl<'a> scale::Encode for CallInput<'a> {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment