Docs: Anys Usage, Events & small cleanups #8895

amaury1093 · 2021-03-16T14:16:17Z

Description

Docs to be backported for 0.42 for:

document Any and MarshalInterface usage (closes Update relevant docs to remove usage of bech32 pubkeys, and document new Any usage #8053) rendered
events (closes Document usage of ' in events #8736) rendered
cleanup usage of linking to master code, prefer permalinks

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

amaury1093 · 2021-03-16T14:17:22Z

docs/architecture/adr-041-in-place-store-migrations.md

@@ -75,7 +75,7 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error {
 }
 ```

-Each module's migration functions are specific to the module's store evolutions, and are not described in this ADR. An example of x/bank store key migrations following the introduction of ADR-028 length-prefixed addresses can be seen [here](https://github.com/cosmos/cosmos-sdk/blob/ef8dabcf0f2ecaf26db1c6c6d5922e9399458bb3/x/bank/legacy/v042/store.go#L15).
+Each module's migration functions are specific to the module's store evolutions, and are not described in this ADR. An example of x/bank store key migrations following the introduction of ADR-028 length-prefixed addresses can be seen [here](https://github.com/cosmos/cosmos-sdk/blob/36f68eb9e041e20a5bb47e216ac5eb8b91f95471/x/bank/legacy/v043/store.go#L41-L62).


ref: #8814 (comment)

barriebyron

So awesome, I've been wanting to look at these docs, thank you for the opportunity to learn about our SDK. We have Event and event, so if we need a consistent capitalization, you might want to pick one and use it consistently. I am starting to understand. Grammatical suggestions and style guidance are provided in this review.

docs/architecture/adr-041-in-place-store-migrations.md

docs/basics/app-anatomy.md

docs/building-modules/simulator.md

docs/core/baseapp.md

docs/core/events.md

Co-authored-by: Barrie Byron <[email protected]>

amaury1093 · 2021-03-17T10:27:49Z

thanks @barriebyron for the review! I actually went through all your points, and they make sense. Also waiting for #8906.

We have Event and event, so if we need a consistent capitalization, you might want to pick one and use it consistently.

I went with Event.

All suggestions have been accepted. Hence dismissing. Thanks Barrie!

Co-authored-by: Barrie Byron <[email protected]> Co-authored-by: Alessio Treglia <[email protected]> (cherry picked from commit 1a4418b) # Conflicts: # docs/architecture/adr-041-in-place-store-migrations.md # docs/basics/app-anatomy.md # docs/core/events.md

Co-authored-by: Barrie Byron <[email protected]> Co-authored-by: Alessio Treglia <[email protected]> (cherry picked from commit 1a4418b) Co-authored-by: Amaury <[email protected]>

amaury1093 added 2 commits March 16, 2021 14:34

Update v042 link

9f47a92

Add docs for events

5bfab35

amaury1093 added T:Docs Changes and features related to documentation. backport/0.42.x (Stargate) labels Mar 16, 2021

amaury1093 commented Mar 16, 2021

View reviewed changes

amaury1093 mentioned this pull request Mar 16, 2021

Update relevant docs to remove usage of bech32 pubkeys, and document new Any usage #8053

Closed

7 tasks

amaury1093 added 2 commits March 16, 2021 16:14

Document usage of any

fc08893

Random cleanups

da42fec

amaury1093 changed the title ~~Docs: Keyring Migration & Events~~ Docs: Keyring Migration, Anys & Events Mar 16, 2021

amaury1093 mentioned this pull request Mar 16, 2021

Cannot use AccountI inside Protobuf messages #8876

Closed

4 tasks

Add UnpackInterfaces

a19b48c

amaury1093 changed the title ~~Docs: Keyring Migration, Anys & Events~~ Docs: Anys Usage, Events & small cleanups Mar 16, 2021

Use tag instead of commit

9e06261

amaury1093 marked this pull request as ready for review March 16, 2021 17:02

amaury1093 requested review from aaronc, alessio and alexanderbez as code owners March 16, 2021 17:02

amaury1093 requested review from blushi, robert-zaremba and anilcse March 16, 2021 17:02

barriebyron previously requested changes Mar 16, 2021

View reviewed changes

amaury1093 and others added 9 commits March 17, 2021 11:12

Update docs/architecture/adr-041-in-place-store-migrations.md

97d8739

Co-authored-by: Barrie Byron <[email protected]>

Update docs/basics/app-anatomy.md

f8b4e1c

Co-authored-by: Barrie Byron <[email protected]>

Update docs/building-modules/simulator.md

e0d1a45

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/baseapp.md

9c92904

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/baseapp.md

35ffaa4

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

7ddd370

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/events.md

68dd03b

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/events.md

4cb4a3a

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/events.md

583a541

Co-authored-by: Barrie Byron <[email protected]>

amaury1093 and others added 13 commits March 17, 2021 11:15

Update docs/core/events.md

46a738d

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/events.md

3e2f4b5

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

b0fd14a

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

de52a4f

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

b74cfa4

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

26f09a5

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

6e94d8a

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

fc789d6

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

1afbd0c

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

a3867c0

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/encoding.md

d84d262

Co-authored-by: Barrie Byron <[email protected]>

Update docs/core/events.md

b791fd0

Co-authored-by: Barrie Byron <[email protected]>

Use consistent casing

9f75522

Merge branch 'master' into am/random-docs

2501e84

alessio approved these changes Mar 17, 2021

View reviewed changes

alessio merged commit 1a4418b into master Mar 17, 2021

alessio deleted the am/random-docs branch March 17, 2021 12:15

mergify bot mentioned this pull request Mar 17, 2021

Docs: Anys Usage, Events & small cleanups (bp #8895) #8911

Merged

dependabot bot mentioned this pull request Mar 18, 2021

Bump github.com/cosmos/cosmos-sdk from 0.40.0-rc5 to 0.42.2-rc0 celestiaorg/celestia-app#51

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Anys Usage, Events & small cleanups #8895

Docs: Anys Usage, Events & small cleanups #8895

amaury1093 commented Mar 16, 2021 •

edited

Loading

amaury1093 Mar 16, 2021

barriebyron left a comment

amaury1093 commented Mar 17, 2021

Docs: Anys Usage, Events & small cleanups #8895

Docs: Anys Usage, Events & small cleanups #8895

Conversation

amaury1093 commented Mar 16, 2021 • edited Loading

Description

amaury1093 Mar 16, 2021

Choose a reason for hiding this comment

barriebyron left a comment

Choose a reason for hiding this comment

amaury1093 commented Mar 17, 2021

amaury1093 commented Mar 16, 2021 •

edited

Loading