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

chore: add godoc to packet server handlers #7156

Merged
merged 2 commits into from
Aug 19, 2024
Merged

chore: add godoc to packet server handlers #7156

merged 2 commits into from
Aug 19, 2024

Conversation

colin-axner
Copy link
Contributor

Description

I also decided to remove comments which I felt provided no value

closes: #7148

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/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

colin-axner
colin-axner commented Aug 13, 2024
View reviewed changes
modules/core/packet-server/keeper/keeper.go
@@ -124,7 +134,6 @@ func (k Keeper) RecvPacket(

// Lookup counterparty associated with our channel and ensure that it was packet was indeed
// sent by our counterparty.
// Note: This can be implemented by the current keeper
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what this was supposed to indicate?

@colin-axner colin-axner marked this pull request as ready for review August 13, 2024 13:13
AdityaSripal
AdityaSripal approved these changes Aug 15, 2024
View reviewed changes
Copy link
Member

@AdityaSripal AdityaSripal left a comment

Choose a reason for hiding this comment

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

Thanks @colin-axner !

modules/core/packet-server/keeper/keeper.go Outdated Show resolved Hide resolved
modules/core/packet-server/keeper/keeper.go Outdated Show resolved Hide resolved
modules/core/packet-server/keeper/keeper.go Outdated Show resolved Hide resolved
modules/core/packet-server/keeper/keeper.go Outdated Show resolved Hide resolved
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed for 'ibc-go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@crodriguezvega crodriguezvega merged commit 1971ad5 into feat/ibc-eureka Aug 19, 2024
63 of 65 checks passed
@crodriguezvega crodriguezvega deleted the colin/7148-godoc branch August 19, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AdityaSripal AdityaSripal AdityaSripal approved these changes

@crodriguezvega crodriguezvega crodriguezvega approved these changes

@damiannolan damiannolan Awaiting requested review from damiannolan damiannolan is a code owner

@chatton chatton Awaiting requested review from chatton

Assignees
No one assigned
Labels
feat: ibc-eureka
Projects
IBC-GO Eureka
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@colin-axner @crodriguezvega @AdityaSripal