Skip to content

Commit 784ebdc

Browse files
authored
Merge pull request #2427 from Pronoss/fix/update
Improve documentation consistency and fix minor typos in MIGRATING.md and cosmos_msg.rs
2 parents 6c602d1 + 102b07a commit 784ebdc

File tree

8 files changed

+18
-18
lines changed

8 files changed

+18
-18
lines changed

MIGRATING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ major releases of `cosmwasm`. Note that you can also view the
2424
`stargate` feature instead, since it was previously implied by `ibc3`.
2525

2626
Also remove any uses of the `backtraces` feature. You can use a
27-
`RUST_BACKTRACE=1` env variable for this now.
27+
`RUST_BACKTRACE=1` environment variable for this now.
2828

2929
If you were using `cosmwasm-std` with `default-features = false`, you probably
3030
want to enable the `std` feature now, as we might move certain existing
@@ -156,10 +156,10 @@ major releases of `cosmwasm`. Note that you can also view the
156156
+StdError::generic_err(msg)
157157
```
158158

159-
- Replace addresses in unit tests with valid bech32 addresses. This has to be
159+
- Replace addresses in unit tests with valid Bech32 addresses. This has to be
160160
done for all addresses that are validated or canonicalized during the test or
161161
within the contract. The easiest way to do this is by using
162-
`MockApi::addr_make`. It generates a bech32 address from any string:
162+
`MockApi::addr_make`. It generates a Bech32 address from any string:
163163

164164
```diff
165165
-let msg = InstantiateMsg {
@@ -172,10 +172,10 @@ major releases of `cosmwasm`. Note that you can also view the
172172
+};
173173
```
174174

175-
- Replace addresses in integration tests using `cosmwasm-vm` with valid bech32
175+
- Replace addresses in integration tests using `cosmwasm-vm` with valid Bech32
176176
addresses. This has to be done for all addresses that are validated or
177177
canonicalized during the test or within the contract. The easiest way to do
178-
this is by using `MockApi::addr_make`. It generates a bech32 address from any
178+
this is by using `MockApi::addr_make`. It generates a Bech32 address from any
179179
string:
180180

181181
```diff
@@ -206,9 +206,9 @@ major releases of `cosmwasm`. Note that you can also view the
206206

207207
- If you were using `QueryRequest::Stargate`, you might want to enable the
208208
`cosmwasm_2_0` cargo feature and migrate to `QueryRequest::Grpc` instead.
209-
While the stargate query sometimes returns protobuf encoded data and sometimes
209+
While the stargate query sometimes returns protobuf-encoded data and sometimes
210210
JSON encoded data, depending on the chain, the gRPC query always returns
211-
protobuf encoded data.
211+
protobuf-encoded data.
212212

213213
```diff
214214
-deps.querier.query(&QueryRequest::Stargate {
@@ -1311,7 +1311,7 @@ arbitrary ones.
13111311

13121312
The existing `CanonicalAddr` remains unchanged and can be used in cases in
13131313
which a compact binary representation is desired. For JSON state this does not
1314-
save much data (e.g. the bech32 address
1314+
save much data (e.g. the Bech32 address
13151315
cosmos1pfq05em6sfkls66ut4m2257p7qwlk448h8mysz takes 45 bytes as direct ASCII
13161316
and 28 bytes when its canonical representation is base64 encoded). For
13171317
fixed-length database keys `CanonicalAddr` remains handy though.

contracts/ibc-reflect-send/schema/ibc-reflect-send.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@
335335
"additionalProperties": false
336336
},
337337
{
338-
"description": "This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
338+
"description": "This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
339339
"type": "object",
340340
"required": [
341341
"withdraw_delegator_reward"

contracts/ibc-reflect-send/schema/ibc/packet_msg.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@
276276
"additionalProperties": false
277277
},
278278
{
279-
"description": "This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
279+
"description": "This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
280280
"type": "object",
281281
"required": [
282282
"withdraw_delegator_reward"

contracts/ibc-reflect-send/schema/raw/execute.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@
324324
"additionalProperties": false
325325
},
326326
{
327-
"description": "This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
327+
"description": "This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
328328
"type": "object",
329329
"required": [
330330
"withdraw_delegator_reward"

contracts/ibc-reflect/schema/ibc/packet_msg.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@
275275
"additionalProperties": false
276276
},
277277
{
278-
"description": "`CosmosMsg::Any` is the replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
278+
"description": "`CosmosMsg::Any` replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
279279
"type": "object",
280280
"required": [
281281
"any"

contracts/reflect/schema/raw/execute.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@
247247
"additionalProperties": false
248248
},
249249
{
250-
"description": "`CosmosMsg::Any` is the replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
250+
"description": "`CosmosMsg::Any` replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
251251
"type": "object",
252252
"required": [
253253
"any"
@@ -357,7 +357,7 @@
357357
"additionalProperties": false
358358
},
359359
{
360-
"description": "This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
360+
"description": "This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
361361
"type": "object",
362362
"required": [
363363
"withdraw_delegator_reward"

contracts/reflect/schema/reflect.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@
257257
"additionalProperties": false
258258
},
259259
{
260-
"description": "`CosmosMsg::Any` is the replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
260+
"description": "`CosmosMsg::Any` replaces the \"stargate message\" – a message wrapped in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any) that is supported by the chain. It behaves the same as `CosmosMsg::Stargate` but has a better name and slightly improved syntax.\n\nThis is feature-gated at compile time with `cosmwasm_2_0` because a chain running CosmWasm < 2.0 cannot process this.",
261261
"type": "object",
262262
"required": [
263263
"any"
@@ -367,7 +367,7 @@
367367
"additionalProperties": false
368368
},
369369
{
370-
"description": "This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
370+
"description": "This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50). `delegator_address` is automatically filled with the current contract's address.",
371371
"type": "object",
372372
"required": [
373373
"withdraw_delegator_reward"

packages/std/src/results/cosmos_msg.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ pub enum CosmosMsg<T = Empty> {
7272
type_url: String,
7373
value: Binary,
7474
},
75-
/// `CosmosMsg::Any` is the replaces the "stargate message" – a message wrapped
75+
/// `CosmosMsg::Any` replaces the "stargate message" – a message wrapped
7676
/// in a [protobuf Any](https://protobuf.dev/programming-guides/proto3/#any)
7777
/// that is supported by the chain. It behaves the same as
7878
/// `CosmosMsg::Stargate` but has a better name and slightly improved syntax.
@@ -176,7 +176,7 @@ pub enum DistributionMsg {
176176
/// The `withdraw_address`
177177
address: String,
178178
},
179-
/// This is translated to a [[MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50).
179+
/// This is translated to a [MsgWithdrawDelegatorReward](https://github.com/cosmos/cosmos-sdk/blob/v0.42.4/proto/cosmos/distribution/v1beta1/tx.proto#L42-L50).
180180
/// `delegator_address` is automatically filled with the current contract's address.
181181
WithdrawDelegatorReward {
182182
/// The `validator_address`

0 commit comments

Comments
 (0)