Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Anys Usage, Events & small cleanups #8895

Merged
merged 29 commits into from
Mar 17, 2021
Merged

Docs: Anys Usage, Events & small cleanups #8895

merged 29 commits into from
Mar 17, 2021

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Mar 16, 2021

Description

Docs to be backported for 0.42 for:


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 amaury1093 added T:Docs Changes and features related to documentation. backport/0.42.x (Stargate) labels Mar 16, 2021
@@ -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).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amaury1093 amaury1093 changed the title Docs: Keyring Migration & Events Docs: Keyring Migration, Anys & Events Mar 16, 2021
@amaury1093 amaury1093 changed the title Docs: Keyring Migration, Anys & Events Docs: Anys Usage, Events & small cleanups Mar 16, 2021
@amaury1093 amaury1093 marked this pull request as ready for review March 16, 2021 17:02
Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
docs/basics/app-anatomy.md Outdated Show resolved Hide resolved
docs/building-modules/simulator.md Outdated Show resolved Hide resolved
docs/core/baseapp.md Outdated Show resolved Hide resolved
docs/core/baseapp.md Outdated Show resolved Hide resolved
docs/core/events.md Outdated Show resolved Hide resolved
docs/core/events.md Outdated Show resolved Hide resolved
docs/core/events.md Outdated Show resolved Hide resolved
docs/core/events.md Outdated Show resolved Hide resolved
docs/core/events.md Outdated Show resolved Hide resolved
amaury1093 and others added 9 commits March 17, 2021 11:12
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
amaury1093 and others added 13 commits March 17, 2021 11:15
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
@amaury1093
Copy link
Contributor Author

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.

@alessio alessio dismissed barriebyron’s stale review March 17, 2021 10:39

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

@alessio alessio merged commit 1a4418b into master Mar 17, 2021
@alessio alessio deleted the am/random-docs branch March 17, 2021 12:15
mergify bot pushed a commit that referenced this pull request Mar 17, 2021
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
(cherry picked from commit 1a4418b)

# Conflicts:
#	docs/architecture/adr-041-in-place-store-migrations.md
#	docs/basics/app-anatomy.md
#	docs/core/events.md
alessio pushed a commit that referenced this pull request Mar 17, 2021
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
(cherry picked from commit 1a4418b)
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
3 participants