Skip to content

Commit

Permalink
fix: apply reviewer comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Farhad-Shabani committed Nov 23, 2023
1 parent 9e654e9 commit e2a0efe
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 17 deletions.
10 changes: 5 additions & 5 deletions .changelog/v0.48.0/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ In this release, we've undertaken a comprehensive overhaul of the **`ibc-rs`**
repository, resulting in a strategic reorganization of the codebase. This
restructuring dissects the implementation of each IBC specification,
categorizing and situating them within relevant libraries. The primary objective
is to elevate ibc-rs practicality and enhance user flexibility by providing a
is to elevate `ibc-rs` practicality and enhance user flexibility by providing a
more modular and composable experience.

Users now have the flexibility to choose from a spectrum of options. They can
opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`,
Users now have the flexibility to choose from a spectrum of dependencies. They
can opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`,
`ibc-clients`, or `ibc-apps`. Alternatively, they can exercise fine-grained
control by selectively importing specific libraries. This can involve bringing
in an entire implemented IBC sub-module, like the `ibc-core-client` crate, or
control by selectively importing specific crates. This can involve bringing in
an entire implemented IBC sub-module, like the `ibc-core-client` crate, or
importing only the associated data structures of a module, such as the
`ibc-core-client-types` crate.

Expand Down
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ In this release, we've undertaken a comprehensive overhaul of the **`ibc-rs`**
repository, resulting in a strategic reorganization of the codebase. This
restructuring dissects the implementation of each IBC specification,
categorizing and situating them within relevant libraries. The primary objective
is to elevate ibc-rs practicality and enhance user flexibility by providing a
is to elevate `ibc-rs` practicality and enhance user flexibility by providing a
more modular and composable experience.

Users now have the flexibility to choose from a spectrum of options. They can
opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`,
Users now have the flexibility to choose from a spectrum of dependencies. They
can opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`,
`ibc-clients`, or `ibc-apps`. Alternatively, they can exercise fine-grained
control by selectively importing specific libraries. This can involve bringing
in an entire implemented IBC sub-module, like the `ibc-core-client` crate, or
control by selectively importing specific crates. This can involve bringing in
an entire implemented IBC sub-module, like the `ibc-core-client` crate, or
importing only the associated data structures of a module, such as the
`ibc-core-client-types` crate.

Expand Down
2 changes: 1 addition & 1 deletion ibc-core/ics02-client/context/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ rust-version = { workspace = true }
license = { workspace = true }
repository = { workspace = true }
keywords = ["blockchain", "cosmos", "ibc"]
readme = "./../README.md"
readme = "./../../README.md"
description = """
Maintaind by `ibc-rs`, contains essential APIs to interface with the host chain's store,
enabling smooth client state transitions. Additionally, provides necessary traits for
Expand Down
2 changes: 1 addition & 1 deletion ibc-core/ics24-host/cosmos/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ rust-version = { workspace = true }
license = { workspace = true }
repository = { workspace = true }
keywords = ["blockchain", "cosmos", "ibc", "tendermint"]
readme = "./../README.md"
readme = "./../../README.md"
description = """
Maintained by `ibc-rs`, contains Cosmos-specific helper traits and implementations
to facilitate IBC integration, ensuring proper interaction with modules/components
Expand Down
9 changes: 4 additions & 5 deletions ibc-core/ics25-handler/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
//!
//! When processing a given message `M`, if any method in this library returns
//! an error, the runtime is expected to rollback all state modifications made
//! to the context (e.g.
//! [`ExecutionContext`](ibc_core_host::ExecutionContext)) while processing
//! `M`. If a transaction on your blockchain contains multiple messages, then
//! typically the state modifications from all messages is expected to be rolled
//! back as well.
//! to the context (e.g. [`ExecutionContext`](ibc_core_host::ExecutionContext))
//! while processing `M`. If the transaction containing `M` consists of multiple
//! messages, then typically the state modifications from all messages is
//! expected to be rolled back as well.
#![no_std]
#![forbid(unsafe_code)]
#![cfg_attr(not(test), deny(clippy::unwrap_used))]
Expand Down

0 comments on commit e2a0efe

Please sign in to comment.