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

chore: update godocs for legacy apis on controller module #2363

Merged
merged 17 commits into from
Oct 14, 2022

Conversation

charleenfei
Copy link
Contributor

Description

closes: #2234


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

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM 🥇 thanks for fixing typo!

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.

LGTM! 🚀

Comment on lines 20 to 22
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying authentication application. For a full summary of the changes in v6.x.x, please see ADR009.
Copy link
Member

Choose a reason for hiding this comment

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

nit

Suggested change
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying authentication application. For a full summary of the changes in v6.x.x, please see ADR009.
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set.
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying application. For a full summary of the changes in v6.x.x, please see ADR009.

Comment on lines 20 to 22
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying authentication application. For a full summary of the changes in v6.x.x, please see ADR009.
Copy link
Member

Choose a reason for hiding this comment

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

same nit

Suggested change
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying authentication application. For a full summary of the changes in v6.x.x, please see ADR009.
// NOTE: this is a legacy API that is only intended to function correctly in workflows where an underlying application has been set.
// Prior to to v6.x.x of ibc-go, the controller module was only functional as middleware, with authentication performed
// by the underlying application. For a full summary of the changes in v6.x.x, please see ADR009.

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.

@charleenfei could you pull in the changes from #2448 here please? See #2448 (comment)

Thanks!

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.

🙏

@charleenfei charleenfei merged commit 95cec44 into main Oct 14, 2022
@charleenfei charleenfei deleted the charly/docs_legacy_api branch October 14, 2022 12:17
mergify bot pushed a commit that referenced this pull request Oct 14, 2022
* update docs for legacy api

(cherry picked from commit 95cec44)

# Conflicts:
#	e2e/tests/transfer/base_test.go
damiannolan pushed a commit that referenced this pull request Oct 19, 2022
…2363) (#2547)

* chore: update godocs for legacy apis on controller module (#2363)

* update docs for legacy api

(cherry picked from commit 95cec44)

# Conflicts:
#	e2e/tests/transfer/base_test.go

* delete e2e test

Co-authored-by: Charly <[email protected]>
Co-authored-by: Carlos Rodriguez <[email protected]>
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.

Add documentation indicating legacy API in controller module
5 participants