fix: adjust comments, markdowns

ibc-apps/README.md

@@ -1,10 +1,10 @@
 # IBC Applications
 
-This crate is a top-level library that re-exports implementations of Inter-Blockchain Communication
-(IBC) applications. It serves as a meta-crate, simplifying the
-process of importing and integrating various IBC applications into your
-blockchain. IBC is a distributed protocol that enables communication between
-distinct sovereign blockchains. IBC applications abstract away the core
+This crate is a top-level library that re-exports implementations of
+Inter-Blockchain Communication (IBC) applications. It serves as a meta-crate,
+simplifying the process of importing and integrating various IBC applications
+into your blockchain. IBC is a distributed protocol that enables communication
+between distinct sovereign blockchains. IBC applications abstract away the core
 transport, authentication, and ordering (TAO) layers, letting blockchain app
 developers focus solely on implementing business logic.
 

ibc-clients/README.md

@@ -1,12 +1,12 @@
 # IBC Clients
 
-This top-level crate re-exports Inter-Blockchain
-Communication (IBC) implementations of light clients. It serves as a meta-crate, simplifying the
+This top-level crate re-exports Inter-Blockchain Communication (IBC)
+implementations of light clients. It serves as a meta-crate, simplifying the
 process of importing and integrating various IBC clients into your blockchain.
 IBC is a distributed protocol that enables communication between distinct
 sovereign blockchains and IBC light clients track the consensus states and proof
-specs of external blockchains, which are required to properly verify proofs against the
-client's consensus state.
+specs of external blockchains, which are required to properly verify proofs
+against the client's consensus state.
 
 The structure within the `ibc-clients` crate is designed to provide flexibility
 for external users. It allows you to utilize the own `ibc-clients` crate or

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

@@ -1,3 +1,13 @@
+//! This module includes trait implementations for the
+//! `ibc_client_tendermint_types::ClientState` type. Implemented traits include
+//! `ClientStateCommon`, `ClientStateValidation`, and `ClientStateExecution`.
+//!
+//! Note that this crate defines a newtype wrapper around the
+//! `ibc_client_tendermint_types::ClientState` type in order to enable
+//! implementing a foreign trait on a foreign type (i.e. the orphan rule in
+//! Rust). As such, this module also includes some trait implementations that
+//! serve to pass through traits implemented on the wrapped `ClientState` type.
+
 use ibc_client_tendermint_types::error::Error;
 use ibc_client_tendermint_types::proto::v1::ClientState as RawTmClientState;
 use ibc_client_tendermint_types::proto::{Any, Protobuf};

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

@@ -1,10 +1,9 @@
-//! This module includes trait implementations for the `ibc_client_tendermint_types::ConsensusState` 
-//! type. It implements the `ConsensusStateTrait` for 
-//! `ConsensusState` by defining a newtype wrapper in order
-//! to circumvent Rust's orphan rule, which disallows foreign
-//! traits from being implemented on foreign types.
-//! This module also includes some trait implementations that serve 
-//! to pass through traits implemented on the wrapped
+//! This module includes trait implementations for the
+//! `ibc_client_tendermint_types::ConsensusState` type. It implements the
+//! `ConsensusStateTrait` for `ConsensusState` by defining a newtype wrapper in
+//! order to circumvent Rust's orphan rule, which disallows foreign traits from
+//! being implemented on foreign types. This module also includes some trait
+//! implementations that serve to pass through traits implemented on the wrapped
 //! `ConsensusState` type.
 
 use ibc_client_tendermint_types::error::Error;

ibc-core/README.md

@@ -1,13 +1,22 @@
 # IBC Core
 
-This is the top-level library that re-exports the Inter-Blockchain Communication (IBC) core modules as a meta-crate. It serves to simplify the process of importing and integrating various IBC core modules into your blockchain.
+This is the top-level library that re-exports the Inter-Blockchain Communication
+(IBC) core modules as a meta-crate. It serves to simplify the process of
+importing and integrating various IBC core modules into your blockchain.
 
-IBC is a distributed protocol that enables communication between distinct sovereign blockchains and IBC core is the part of the protocol that handles the transport, authentication, and ordering (TAO) of data packets.
+IBC is a distributed protocol that enables communication between distinct
+sovereign blockchains and IBC core is the part of the protocol that handles the
+transport, authentication, and ordering (TAO) of data packets.
 
 The structure within the `ibc-core` crate is designed to provide flexibility for
-external users. You can choose to utilize the entire `ibc-core` crate, or selectively import specific libraries. From there, you also have the flexibility of bringing in an entire sub-module (e.g. the `ibc-core-client` crate), or only a module's associated data structures (e.g. `ibc-core-client-types`).
-
-This versatility empowers hosts, including chain integrators, relayers, or any IBC tooling projects, to build their solution on top of the layers that best suit their particular requirements.
+external users. You can choose to utilize the entire `ibc-core` crate, or
+selectively import specific libraries. From there, you also have the flexibility
+of bringing in an entire sub-module (e.g. the `ibc-core-client` crate), or only
+a module's associated data structures (e.g. `ibc-core-client-types`).
+
+This versatility empowers hosts, including chain integrators, relayers, or any
+IBC tooling projects, to build their solution on top of the layers that best
+suit their particular requirements.
 
 ## Sub-Crates
 

ibc-derive/README.md

@@ -1,9 +1,9 @@
 # IBC Derive
 
 This crate provides a set of procedural macros for deriving IBC-related traits
-defined in the [`ibc-rs`](https://github.com/cosmos/ibc-rs) repository. reducing
-the amount of boilerplate code required to implement them. It already contains
-macro implementations for the following traits:
+defined in the [`ibc-rs`](https://github.com/cosmos/ibc-rs) repository, reducing
+the amount of boilerplate code required to implement them. It contains macro
+implementations for the following traits:
 
 - [ClientState](./../ibc-core/ics02-client/context/src/client_state.rs)
 - [ConsensusState](./../ibc-core/ics02-client/context/src/consensus_state.rs)