chore: fix grammar in doc comments (#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))]