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 for channel upgrades CLI #5553

Merged
merged 18 commits into from
Jan 10, 2024
Merged

Conversation

chatton
Copy link
Contributor

@chatton chatton commented Jan 9, 2024

Description

ref #5548

Also realizing, after this gets merged I can update #5504 to reference this CLI instead of gov submit proposal.


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.

Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

lgtm, left minor nits

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
Comment on lines 174 to 175
The following example, would submit a governance proposal with the specified deposit, title and summary which would
contain a `MsgChanUpgradeInit` for all `OPEN` channels whose port matches the regular expression `transfer`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following example, would submit a governance proposal with the specified deposit, title and summary which would
contain a `MsgChanUpgradeInit` for all `OPEN` channels whose port matches the regular expression `transfer`.
The following example, would submit a governance proposal with the specified deposit, title and summary while also containing a `MsgChannelUpgradeInit` for all `OPEN` channels whose port matches the regular expression `transfer`.

Copy link
Contributor

Choose a reason for hiding this comment

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

i kind of prefer @chatton's version tbh bc the proposal is there to contain (approve) the MsgChannelUpgradeInit, but it's a super nit really.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will leave as is if you guys are okay with it then?

Copy link
Contributor

Choose a reason for hiding this comment

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

ah, maybe just the MsgChannelUpgradeInit as opposed to MsgChanUpgradeInit? (git diff isn't particularly good at showing the specific diffs).

Wording is perfectly fine by me either way!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah missed the typo, thanks @DimitrisJim

Copy link
Contributor

@charleenfei charleenfei left a comment

Choose a reason for hiding this comment

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

great work @chatton! thanks for all these docs

chatton and others added 3 commits January 9, 2024 12:24
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

🚀

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
@chatton chatton enabled auto-merge (squash) January 10, 2024 09:18
@chatton chatton merged commit f9b918f into main Jan 10, 2024
62 of 63 checks passed
@chatton chatton deleted the cian/issue#5540-upgrade-channels-cli-docs branch January 10, 2024 09:21
charleenfei pushed a commit that referenced this pull request Jan 11, 2024
charleenfei pushed a commit that referenced this pull request Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants