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.

Sign up for GitHub

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

Jump to bottom

Label args as upgrade parameters for better readability #5463

Closed
3 tasks
damiannolan opened this issue Dec 19, 2023 · 1 comment · Fixed by #5512
Closed
3 tasks

Label args as upgrade parameters for better readability #5463

damiannolan opened this issue Dec 19, 2023 · 1 comment · Fixed by #5512
Assignees
@chatton
Labels
audit Feedback from implementation audit channel-upgradability Channel upgradability feature good first issue Good for newcomers type: code hygiene Clean up code but without changing functionality or interfaces
Milestone
04-channel upgrad...

Comments

@damiannolan
Copy link
Contributor

Summary

In application upgrade callbacks, name the arguments/parameters of each of the API callbacks as upgrade fields / proposed fields for better readability.

For example:

  • connectionHops -> proposedConnectionHops or upgradeConnectionHops
  • order -> proposedOrder or upgradeOrder
  • version -> proposedVersion or upgradeVersion

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged/assigned
@damiannolan damiannolan added type: code hygiene Clean up code but without changing functionality or interfaces audit Feedback from implementation audit channel-upgradability Channel upgradability feature labels Dec 19, 2023
@damiannolan damiannolan added this to the 04-channel upgrades RC milestone Dec 19, 2023
@damiannolan
Copy link
Contributor Author

Personally I would vote for the upgrade prefix rather than proposed

@crodriguezvega crodriguezvega moved this to Todo in ibc-go Jan 1, 2024
@crodriguezvega crodriguezvega added the good first issue Good for newcomers label Jan 1, 2024
@chatton chatton self-assigned this Jan 4, 2024
@chatton chatton mentioned this issue Jan 4, 2024
Merged
9 tasks
@chatton chatton moved this from Todo to In review in ibc-go Jan 4, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in ibc-go Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chatton chatton

Labels
audit Feedback from implementation audit channel-upgradability Channel upgradability feature good first issue Good for newcomers type: code hygiene Clean up code but without changing functionality or interfaces
Projects
ibc-go
Archived in project
Milestone
04-channel upgrades RC
Development

Successfully merging a pull request may close this issue.

Update parameter names for better readability cosmos/ibc-go
3 participants
@damiannolan @crodriguezvega @chatton