chore: fix grammar in doc comments (informalsystems#1222)

* chore: Remove duplicate words

* bunch of grammar fixes

---------

Co-authored-by: Ranadeep Biswas <[email protected]>
Co-authored-by: Sean Chen <[email protected]>

Author: 3 people

ibc-apps/ics20-transfer/src/context.rs

@@ -21,7 +21,7 @@ pub trait TokenTransferValidationContext {
 
     /// Validates that the tokens can be escrowed successfully.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// escrow validation.
     fn escrow_coins_validate(
         &self,
@@ -50,7 +50,7 @@ pub trait TokenTransferValidationContext {
 
     /// Validates the sender account and the coin input before burning.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// burn validation.
     fn burn_coins_validate(
         &self,
@@ -70,7 +70,7 @@ pub trait TokenTransferValidationContext {
 pub trait TokenTransferExecutionContext: TokenTransferValidationContext {
     /// Executes the escrow of the tokens in a user account.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// escrow execution.
     fn escrow_coins_execute(
         &mut self,
@@ -99,7 +99,7 @@ pub trait TokenTransferExecutionContext: TokenTransferValidationContext {
 
     /// Executes burning of the tokens in a user account.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// burn execution.
     fn burn_coins_execute(
         &mut self,

ibc-apps/ics20-transfer/types/src/denom.rs

@@ -90,7 +90,7 @@ impl TracePrefix {
     /// it returns a tuple of the removed [`TracePrefix`] and the substring after the prefix.
     ///
     /// If the substring is empty, it returns `None`.
-    /// Otherwise the substring starts with `/`. In that case,
+    /// Otherwise, the substring starts with `/`. In that case,
     /// the leading `/` is stripped and returned.
     ///
     /// If the string does not start with a [`TracePrefix`], this method returns `None`.
@@ -174,7 +174,7 @@ impl TracePath {
     /// [`TracePath`] and the substring after the [`TracePath`].
     ///
     /// If the substring is empty, it returns `None`.
-    /// Otherwise the substring starts with `/`. In that case,
+    /// Otherwise, the substring starts with `/`. In that case,
     /// the leading `/` is stripped and returned.
     ///
     /// If the string does not contain any [`TracePrefix`], it returns the original string.
@@ -273,7 +273,7 @@ impl PrefixedDenom {
     }
 }
 
-/// Returns true if the denomination originally came from the sender chain and
+/// Returns true if the denomination originally came from the sender chain, and
 /// false otherwise.
 ///
 /// Note: It is better to think of the "source" chain as the chain that
@@ -305,7 +305,7 @@ pub fn is_sender_chain_source(
     !is_receiver_chain_source(source_port, source_channel, denom)
 }
 
-/// Returns true if the denomination originally came from the receiving chain and false otherwise.
+/// Returns true if the denomination originally came from the receiving chain, and false otherwise.
 pub fn is_receiver_chain_source(
     source_port: PortId,
     source_channel: ChannelId,

ibc-apps/ics20-transfer/types/src/error.rs

@@ -43,7 +43,7 @@ pub enum TokenTransferError {
     MalformedTrace(String),
     /// trace length must be even but got: `{len}`
     InvalidTraceLength { len: u64 },
-    /// invalid amount error: `{0}`
+    /// invalid amount: `{0}`
     InvalidAmount(FromDecStrErr),
     /// invalid token
     InvalidToken,
@@ -75,7 +75,7 @@ pub enum TokenTransferError {
     UnknownMsgType { msg_type: String },
     /// invalid coin string: `{coin}`
     InvalidCoin { coin: String },
-    /// decoding raw bytes as UTF8 string error: `{0}`
+    /// decoding raw bytes as UTF-8 string error: `{0}`
     Utf8Decode(Utf8Error),
     /// other error: `{0}`
     Other(String),

ibc-apps/ics20-transfer/types/src/lib.rs

@@ -46,8 +46,8 @@ pub const PORT_ID_STR: &str = "transfer";
 /// ICS20 application current version.
 pub const VERSION: &str = "ics20-1";
 
-/// The successful string used for creating an acknowledgement status,
-/// equivalent to `base64::encode(0x01)`.
+/// The successful string, used for creating an acknowledgement status.
+/// It is equivalent to `base64::encode(0x01)`.
 pub const ACK_SUCCESS_B64: &str = "AQ==";
 
 use ibc_core::channel::types::acknowledgement::StatusValue;

ibc-apps/ics721-nft-transfer/src/context.rs

@@ -67,7 +67,7 @@ pub trait NftTransferValidationContext {
     /// Validates that the tokens can be escrowed successfully.
     ///
     /// The owner of the NFT should be checked in this validation.
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// escrow validation.
     fn escrow_nft_validate(
         &self,
@@ -109,7 +109,7 @@ pub trait NftTransferValidationContext {
     /// Validates the sender account and the coin input before burning.
     ///
     /// The owner of the NFT should be checked in this validation.
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// burn validation.
     fn burn_nft_validate(
         &self,
@@ -153,7 +153,7 @@ pub trait NftTransferExecutionContext: NftTransferValidationContext {
 
     /// Executes the escrow of the NFT in a user account.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// escrow execution.
     fn escrow_nft_execute(
         &mut self,
@@ -187,7 +187,7 @@ pub trait NftTransferExecutionContext: NftTransferValidationContext {
 
     /// Executes burning of the NFT in a user account.
     ///
-    /// `memo` field allows to incorporate additional contextual details in the
+    /// `memo` field allows incorporating additional contextual details in the
     /// burn execution.
     fn burn_nft_execute(
         &mut self,

ibc-apps/ics721-nft-transfer/types/src/class.rs

@@ -92,7 +92,7 @@ impl PrefixedClassId {
     }
 }
 
-/// Returns true if the class ID originally came from the sender chain and false otherwise.
+/// Returns true if the class ID originally came from the sender chain, and false otherwise.
 pub fn is_sender_chain_source(
     source_port: PortId,
     source_channel: ChannelId,
@@ -101,7 +101,7 @@ pub fn is_sender_chain_source(
     !is_receiver_chain_source(source_port, source_channel, class_id)
 }
 
-/// Returns true if the class ID originally came from the receiving chain and false otherwise.
+/// Returns true if the class ID originally came from the receiving chain, and false otherwise.
 pub fn is_receiver_chain_source(
     source_port: PortId,
     source_channel: ChannelId,

ibc-apps/ics721-nft-transfer/types/src/error.rs

@@ -86,7 +86,7 @@ pub enum NftTransferError {
     DecodeRawMsg { reason: String },
     /// unknown msg type: `{msg_type}`
     UnknownMsgType { msg_type: String },
-    /// decoding raw bytes as UTF8 string error: `{0}`
+    /// decoding raw bytes as UTF-8 string error: `{0}`
     Utf8Decode(Utf8Error),
     /// other error: `{0}`
     Other(String),

ibc-apps/ics721-nft-transfer/types/src/lib.rs

@@ -45,8 +45,8 @@ pub const PORT_ID_STR: &str = "nft-transfer";
 /// ICS-721 application current version.
 pub const VERSION: &str = "ics721-1";
 
-/// The successful string used for creating an acknowledgement status,
-/// equivalent to `base64::encode(0x01)`.
+/// The successful string, used for creating an acknowledgement status.
+/// It is equivalent to `base64::encode(0x01)`.
 pub const ACK_SUCCESS_B64: &str = "AQ==";
 
 use ibc_core::channel::types::acknowledgement::StatusValue;

ibc-clients/cw-context/src/context/mod.rs

@@ -23,16 +23,16 @@ use crate::utils::AnyCodec;
 
 type Checksum = Vec<u8>;
 
-/// - [`Height`] can not be used directly as keys in the map,
+/// - [`Height`] cannot be used directly as keys in the map,
 /// as it doesn't implement some cw_storage specific traits.
 /// - Only a sorted set is needed. So the value type is set to
 /// [`Empty`] following
 /// ([cosmwasm-book](https://book.cosmwasm.com/cross-contract/map-storage.html#maps-as-sets)).
 pub const CONSENSUS_STATE_HEIGHT_MAP: Map<'_, (u64, u64), Empty> =
     Map::new(ITERATE_CONSENSUS_STATE_PREFIX);
 
-/// Context is a wrapper around the deps and env that gives access to the
-/// methods under the ibc-rs Validation and Execution traits.
+/// Context is a wrapper around the deps and env that provides access
+/// to the methods under the ibc-rs Validation and Execution traits.
 pub struct Context<'a, C: ClientType<'a>>
 where
     <C::ClientState as TryFrom<Any>>::Error: Into<ClientError>,

ibc-clients/cw-context/src/lib.rs

@@ -1,10 +1,10 @@
 //! Contains types and implementations that are needed to integrate a light
-//! client, built using ibc-rs, into CosmWasm contract. This crate functions as
+//! client, built using ibc-rs, into a CosmWasm contract. This crate functions as
 //! a library, allowing users to import the ready-made `Context` object that is
 //! generic across light clients, introduce their concrete client type and
 //! integrate their assembled context into the CosmWasm contract's entrypoint.
 //! NOTE: To utilize the CosmWasm contract developed using this library, hosting
-//! environments must support CosmWasm module and be using one the versions of
+//! environments must support the CosmWasm module and be using one of the versions of
 //! `ibc-go` that supports the `08-wasm` proxy light client.
 
 #![cfg_attr(not(test), deny(clippy::unwrap_used))]

ibc-clients/ics07-tendermint/src/client_state.rs

@@ -27,7 +27,7 @@ pub use misbehaviour::*;
 pub use update_client::*;
 pub use validation::*;
 
-/// Newtype wrapper around the `ClientState` type imported from the
+/// Newtype wrapper around the `ClientState` type, imported from the
 /// `ibc-client-tendermint-types` crate. This wrapper exists so that we can
 /// bypass Rust's orphan rules and implement traits from
 /// `ibc::core::client::context` on the `ClientState` type.

ibc-clients/ics07-tendermint/src/client_state/misbehaviour.rs

@@ -16,7 +16,7 @@ use tendermint_light_client_verifier::Verifier;
 
 use crate::types::Header;
 
-/// Determines whether or not two conflicting headers at the same height would
+/// Determines if two conflicting headers at the same height would
 /// have convinced the light client.
 pub fn verify_misbehaviour<V, H>(
     ctx: &V,

ibc-clients/ics07-tendermint/src/client_state/validation.rs

@@ -137,8 +137,8 @@ where
 /// 1 - fork:
 /// Assumes at least one consensus state before the fork point exists. Let
 /// existing consensus states on chain B be: [Sn,.., Sf, Sf-1, S0] with
-/// `Sf-1` being the most recent state before fork. Chain A is queried for a
-/// header `Hf'` at `Sf.height` and if it is different than the `Hf` in the
+/// `Sf-1` being the most recent state before the fork. Chain A is queried for
+/// a header `Hf'` at `Sf.height` and if it is different from the `Hf` in the
 /// event for the client update (the one that has generated `Sf` on chain),
 /// then the two headers are included in the evidence and submitted. Note
 /// that in this case the headers are different but have the same height.

ibc-clients/ics07-tendermint/types/src/error.rs

@@ -52,7 +52,7 @@ pub enum Error {
     MissingUnbondingPeriod,
     /// negative max clock drift
     NegativeMaxClockDrift,
-    /// missing latest height
+    /// missing the latest height
     MissingLatestHeight,
     /// invalid raw header error: `{0}`
     InvalidRawHeader(TendermintError),
@@ -79,7 +79,7 @@ pub enum Error {
     VerificationError { detail: Box<LightClientErrorDetail> },
     /// Processed time or height for the client `{client_id}` at height `{height}` not found
     UpdateMetaDataNotFound { client_id: ClientId, height: Height },
-    /// The given hash of the validators does not matches the given hash in the signed header. Expected: `{signed_header_validators_hash}`, got: `{validators_hash}`
+    /// The given hash of the validators does not match the given hash in the signed header. Expected: `{signed_header_validators_hash}`, got: `{validators_hash}`
     MismatchValidatorsHashes {
         validators_hash: Hash,
         signed_header_validators_hash: Hash,
@@ -91,7 +91,7 @@ pub enum Error {
     },
     /// headers block hashes are equal
     MisbehaviourHeadersBlockHashesEqual,
-    /// headers are not at same height and are monotonically increasing
+    /// headers are not at the same height and are monotonically increasing
     MisbehaviourHeadersNotAtSameHeight,
 }
 

ibc-clients/ics07-tendermint/types/src/trust_threshold.rs

@@ -12,7 +12,7 @@ use tendermint::trust_threshold::TrustThresholdFraction;
 /// [`TrustThreshold`] defines the level of trust that a client has
 /// towards a set of validators of a chain.
 ///
-/// A trust threshold is represented as a fraction, i.e., a numerator and
+/// A trust threshold is represented as a fraction, i.e., a numerator
 /// and a denominator.
 /// A typical trust threshold is 1/3 in practice.
 /// This type accepts even a value of 0, (numerator = 0, denominator = 0),

ibc-core/ics02-client/context/src/client_state.rs

@@ -27,7 +27,7 @@ pub trait ClientStateCommon: Convertible<Any> {
     /// Type of client associated with this state (eg. Tendermint)
     fn client_type(&self) -> ClientType;
 
-    /// Latest height the client was updated to
+    /// The latest height the client was updated to
     fn latest_height(&self) -> Height;
 
     /// Validate that the client is at a sufficient height
@@ -36,7 +36,7 @@ pub trait ClientStateCommon: Convertible<Any> {
     /// Verify the upgraded client and consensus states and validate proofs
     /// against the given root.
     ///
-    /// NOTE: proof heights are not included as upgrade to a new revision is
+    /// NOTE: proof heights are not included, as upgrade to a new revision is
     /// expected to pass only on the last height committed by the current
     /// revision. Clients are responsible for ensuring that the planned last
     /// height of the current revision is somehow encoded in the proof
@@ -205,7 +205,7 @@ where
 
 /// Primary client trait. Defines all the methods that clients must implement.
 ///
-/// `ClientState` is broken up in 3 separate traits to avoid needing to use
+/// `ClientState` is broken up into 3 separate traits to avoid needing to use
 /// fully qualified syntax for every method call (see ADR 7 for more details).
 /// One only needs to implement [`ClientStateCommon`], [`ClientStateValidation`]
 /// and [`ClientStateExecution`]; a blanket implementation will automatically

ibc-core/ics02-client/types/src/error.rs

@@ -97,7 +97,7 @@ pub enum ClientError {
     Ics23Verification(CommitmentError),
     /// misbehaviour handling failed with reason: `{reason}`
     MisbehaviourHandlingFailure { reason: String },
-    /// client specific error: `{description}`
+    /// client-specific error: `{description}`
     ClientSpecific { description: String },
     /// client counter overflow error
     CounterOverflow,

ibc-core/ics02-client/types/src/height.rs

@@ -158,7 +158,7 @@ pub enum HeightError {
     },
     /// attempted to parse an invalid zero height
     ZeroHeight,
-    /// the height(`{raw_height}`) is not valid format, this format must be used: \[revision_number\]-\[revision_height\]
+    /// the height(`{raw_height}`) is not a valid format, this format must be used: \[revision_number\]-\[revision_height\]
     InvalidFormat { raw_height: String },
 }
 

ibc-core/ics02-client/types/src/msgs/misbehaviour.rs

@@ -28,7 +28,7 @@ pub const SUBMIT_MISBEHAVIOUR_TYPE_URL: &str = "/ibc.core.client.v1.MsgSubmitMis
 pub struct MsgSubmitMisbehaviour {
     /// client unique identifier
     pub client_id: ClientId,
-    /// misbehaviour used for freezing the light client
+    /// misbehaviour, used for freezing the light client
     pub misbehaviour: ProtoAny,
     /// signer address
     pub signer: Signer,

ibc-core/ics02-client/types/src/msgs/update_client.rs

@@ -13,7 +13,7 @@ pub const UPDATE_CLIENT_TYPE_URL: &str = "/ibc.core.client.v1.MsgUpdateClient";
 
 /// Represents the message that triggers the update of an on-chain (IBC) client
 /// either with new headers, or evidence of misbehaviour.
-/// Note that some types of misbehaviour can be detected when a headers
+/// Note that some types of misbehaviour can be detected when the headers
 /// are updated (`UpdateKind::UpdateClient`).
 #[cfg_attr(
     feature = "borsh",

ibc-core/ics03-connection/types/src/connection.rs

@@ -488,7 +488,7 @@ impl State {
         }
     }
 
-    /// Parses the State out from a i32.
+    /// Parses the State out from an i32.
     pub fn from_i32(s: i32) -> Result<Self, ConnectionError> {
         match s {
             0 => Ok(Self::Uninitialized),
@@ -502,13 +502,13 @@ impl State {
         }
     }
 
-    /// Returns whether or not this connection state is `Open`.
+    /// Returns if this connection state is `Open`.
     pub fn is_open(self) -> bool {
         self == State::Open
     }
 
-    /// Returns whether or not this connection with this state
-    /// has progressed less or the same than the argument.
+    /// Returns if this connection with this state
+    /// has progressed less than or the same as the argument.
     ///
     /// # Example
     /// ```rust,ignore

ibc-core/ics03-connection/types/src/error.rs

@@ -69,12 +69,12 @@ pub enum ConnectionError {
     },
     /// invalid client state: `{reason}`
     InvalidClientState { reason: String },
-    /// not enough blocks elapsed, current height `{current_host_height}` is still less than earliest acceptable height `{earliest_valid_height}`
+    /// not enough blocks elapsed, current height `{current_host_height}` is still less than the earliest acceptable height `{earliest_valid_height}`
     NotEnoughBlocksElapsed {
         current_host_height: Height,
         earliest_valid_height: Height,
     },
-    /// not enough time elapsed, current timestamp `{current_host_time}` is still less than earliest acceptable timestamp `{earliest_valid_time}`
+    /// not enough time elapsed, current timestamp `{current_host_time}` is still less than the earliest acceptable timestamp `{earliest_valid_time}`
     NotEnoughTimeElapsed {
         current_host_time: Timestamp,
         earliest_valid_time: Timestamp,

ibc-core/ics03-connection/types/src/msgs/conn_open_ack.rs

@@ -21,9 +21,9 @@ pub const CONN_OPEN_ACK_TYPE_URL: &str = "/ibc.core.connection.v1.MsgConnectionO
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct MsgConnectionOpenAck {
-    /// ConnectionId that chain A has chosen for it's ConnectionEnd
+    /// ConnectionId that chain A has chosen for its ConnectionEnd
     pub conn_id_on_a: ConnectionId,
-    /// ConnectionId that chain B has chosen for it's ConnectionEnd
+    /// ConnectionId that chain B has chosen for its ConnectionEnd
     pub conn_id_on_b: ConnectionId,
     /// ClientState of client tracking chain A on chain B
     pub client_state_of_a_on_b: Any,

ibc-core/ics03-connection/types/src/msgs/conn_open_confirm.rs

@@ -19,7 +19,7 @@ pub const CONN_OPEN_CONFIRM_TYPE_URL: &str = "/ibc.core.connection.v1.MsgConnect
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct MsgConnectionOpenConfirm {
-    /// ConnectionId that chain B has chosen for it's ConnectionEnd
+    /// ConnectionId that chain B has chosen for its ConnectionEnd
     pub conn_id_on_b: ConnectionId,
     /// proof of ConnectionEnd stored on Chain A during ConnOpenInit
     pub proof_conn_end_on_a: CommitmentProofBytes,