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

Improving docstrings for UpgradableModule interface #5474

Conversation

chatton
Copy link
Contributor

@chatton chatton commented Dec 21, 2023

Description

closes: #5466


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 the 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 and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

@colin-axner colin-axner added the channel-upgradability Channel upgradability feature label Dec 21, 2023
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
modules/core/05-port/types/module.go Outdated Show resolved Hide resolved
@chatton chatton force-pushed the cian/issue#5466-update-documentation-on-upgradablemodule-interface-functions branch from b210d72 to c4781ba Compare January 3, 2024 10:25
@chatton chatton changed the base branch from 04-channel-upgrades to main January 3, 2024 10:25
@chatton chatton force-pushed the cian/issue#5466-update-documentation-on-upgradablemodule-interface-functions branch from 16fa22f to 1e5d0c6 Compare January 3, 2024 10:27
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Crystal clear documentation!

@crodriguezvega crodriguezvega merged commit 26fd1e0 into main Jan 5, 2024
63 checks passed
@crodriguezvega crodriguezvega deleted the cian/issue#5466-update-documentation-on-upgradablemodule-interface-functions branch January 5, 2024 14:08
mergify bot pushed a commit that referenced this pull request Jan 5, 2024
* chore: merge main

* chore: corrected commit

* Document ibc app expectations and recommendations (#5506)

* fix typo

---------

Co-authored-by: Charly <charly@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 26fd1e0)
crodriguezvega pushed a commit that referenced this pull request Jan 8, 2024
* chore: merge main

* chore: corrected commit

* Document ibc app expectations and recommendations (#5506)

* fix typo

---------

Co-authored-by: Charly <charly@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 26fd1e0)

Co-authored-by: Cian Hatton <cian@interchain.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
channel-upgradability Channel upgradability feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation on UpgradableModule interface functions
5 participants