From e4e9f271e95737bb2f4c7ff08f42470813214dbf Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Tue, 31 Oct 2023 23:48:42 +0800 Subject: [PATCH] docs: fix typos (#1319) * fix typos in comments * docs: fix typos --- README.md | 2 +- docs/advanced_usage.md | 2 +- docs/chain_implementation.md | 2 +- relayer/chains/cosmos/log.go | 2 +- relayer/chains/penumbra/log.go | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index eaeef11d5..9fc564aee 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Additional information on how IBC works can be found [here](https://ibc.cosmos.n - [Relayer Terminology](./docs/terminology.md) - [New Chain Implementation](./docs/chain_implementation.md) - [Recommended Pruning Settings](./docs/node_pruning.md) -- [Demo/Dev-Environmnet](./examples/README.md) +- [Demo/Dev-Environment](./examples/README.md) --- ## Basic Usage - Relaying Packets Across Chains diff --git a/docs/advanced_usage.md b/docs/advanced_usage.md index 7dd5fcb9e..23e76e307 100644 --- a/docs/advanced_usage.md +++ b/docs/advanced_usage.md @@ -35,7 +35,7 @@ By default, the Relayer will automatically update clients (`MsgUpdateClient`) if > This auto-update functionality is specifically useful on low trafficked paths where messages aren't regularly being relayed. -Alternitavely, you can choose to update clients more frequently by using the `--time-threshold` flag when running the `rly start` command. +Alternatively, you can choose to update clients more frequently by using the `--time-threshold` flag when running the `rly start` command. Example: diff --git a/docs/chain_implementation.md b/docs/chain_implementation.md index 385526c90..ba0121c6d 100644 --- a/docs/chain_implementation.md +++ b/docs/chain_implementation.md @@ -44,7 +44,7 @@ After this, before the main poll loop or subscriber begins, two `ChainProcessor` These caches are aliased types to `map[ConnectionKey]bool` and `map[ChannelKey]bool` respectively. The `PathProcessor` needs to know which connections are open and which channels are open. A value of `true` for the specific `ConnectionKey` or `ChannelKey` will inform the `PathProcessor` that the connection or channel is open later on once these caches are shared with the `PathProcessor`. -During the initalization of these caches, separate mappings should also be built for which connections belong to which clients and which channels belong to which connections. The example of these in the `CosmosChainProcessor` are: +During the initialization of these caches, separate mappings should also be built for which connections belong to which clients and which channels belong to which connections. The example of these in the `CosmosChainProcessor` are: ```go // map of connection ID to client ID diff --git a/relayer/chains/cosmos/log.go b/relayer/chains/cosmos/log.go index 22342e549..d0472a820 100644 --- a/relayer/chains/cosmos/log.go +++ b/relayer/chains/cosmos/log.go @@ -126,7 +126,7 @@ func (cc *CosmosProvider) LogSuccessTx(res *sdk.TxResponse, msgs []provider.Rela zap.String("tx_hash", res.TxHash), ) - // Log the succesful transaction with fields + // Log the successful transaction with fields cc.log.Info( "Successful transaction", fields..., diff --git a/relayer/chains/penumbra/log.go b/relayer/chains/penumbra/log.go index b1f110cf0..65a9d8b26 100644 --- a/relayer/chains/penumbra/log.go +++ b/relayer/chains/penumbra/log.go @@ -114,7 +114,7 @@ func (cc *PenumbraProvider) LogSuccessTx(res *sdk.TxResponse, msgs []provider.Re zap.String("tx_hash", res.TxHash), ) - // Log the succesful transaction with fields + // Log the successful transaction with fields cc.log.Info( "Successful transaction", fields...,