cronos icon indicating copy to clipboard operation
cronos copied to clipboard

chore: fix inconsistent struct name in comment

Open zhedazijingang opened this issue 6 months ago โ€ข 4 comments

๐Ÿ‘ฎ๐Ÿป๐Ÿ‘ฎ๐Ÿป๐Ÿ‘ฎ๐Ÿป !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! ๐Ÿ‘ฎ๐Ÿป๐Ÿ‘ฎ๐Ÿป๐Ÿ‘ฎ๐Ÿป

PR Checklist:

  • [x] Have you read the CONTRIBUTING.md?
  • [ ] Does your PR follow the C4 patch requirements?
  • [ ] Have you rebased your work on top of the latest master?
  • [ ] Have you checked your code compiles? (make)
  • [ ] Have you included tests for any non-trivial functionality?
  • [ ] Have you checked your code passes the unit tests? (make test)
  • [ ] Have you checked your code formatting is correct? (go fmt)
  • [ ] Have you checked your basic code style is fine? (golangci-lint run)
  • [ ] If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • [ ] If your changes affect the client infrastructure, have you run the integration test?
  • [ ] If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • [ ] If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • [ ] If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

fix inconsistent struct name in comment

Summary by CodeRabbit

  • Documentation
    • Corrected an API comment to reference the proper response type, clarifying the request/response pairing.
    • Confirmed no changes to message structures, fields, or runtime behavior.
    • Improves clarity in API docs to help integrators implement and troubleshoot more easily.

zhedazijingang avatar Aug 28 '25 07:08 zhedazijingang

Walkthrough

Updated a comment in proto/cronos/query.proto to correctly reference ContractByDenomResponse as the response type above its message definition; no message fields, RPCs, or behavior were changed.

Changes

Cohort / File(s) Change summary
Proto docs fix
proto/cronos/query.proto
Corrected inline comment to state ContractByDenomResponse (previously mislabeled). No schema, RPC, or logic changes.

Estimated code review effort

๐ŸŽฏ 1 (Trivial) | โฑ๏ธ ~2 minutes

Poem

I nibble at comments with whiskers so keen,
A typo hops out and is tidy and clean.
No contracts were harmed, no messages swapped,
Just a note in the proto, politely cropped.
Hopโ€”docs aligned, and my garden's well-topped! ๐Ÿฅ•๐Ÿ‡

Pre-merge checks and finishing touches

โœ… Passed checks (3 passed)
Check name Status Explanation
Description Check โœ… Passed Check skipped - CodeRabbitโ€™s high-level summary is enabled.
Title check โœ… Passed The title 'chore: fix inconsistent struct name in comment' accurately describes the main change, which is correcting an inline comment that incorrectly identified the struct name in proto/cronos/query.proto.
Docstring Coverage โœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
โœจ Finishing touches
๐Ÿงช Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

๐Ÿ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

๐Ÿ“ฅ Commits

Reviewing files that changed from the base of the PR and between e61b1e74eb72ee3af8c2752a445c7a226f3a1824 and b9e3c9f044753d1b9cac710cca08545e86d996a3.

โ›” Files ignored due to path filters (1)
  • x/cronos/types/query.pb.go is excluded by !**/*.pb.go
๐Ÿ“’ Files selected for processing (1)
  • proto/cronos/query.proto (1 hunks)
โฐ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
  • GitHub Check: Run golangci-lint
  • GitHub Check: integration_tests (gov)
  • GitHub Check: integration_tests (ibc_rly_gas)
  • GitHub Check: integration_tests (slow)
  • GitHub Check: integration_tests (upgrade)
  • GitHub Check: integration_tests (ica)
  • GitHub Check: integration_tests (ibc_update_client)
  • GitHub Check: integration_tests (gas)
  • GitHub Check: integration_tests (unmarked)
  • GitHub Check: integration_tests (ibc)
  • GitHub Check: integration_tests (ibc_rly_evm)
  • GitHub Check: integration_tests (ibc_timeout)
  • GitHub Check: unittest
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: build (macos-14)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Analyze (go)
๐Ÿ”‡ Additional comments (1)
proto/cronos/query.proto (1)

55-55: Verify that generated protobuf files were regenerated.

The comment fix is correct and now consistently identifies ContractByDenomResponse as the response type. However, the previous reviewer (randy-cro) explicitly requested running make proto-gen to update the generated .pb files. Please confirm that the generated protobuf files (e.g., .pb.go, .pb.gw.go, or similar) have been regenerated and committed alongside this change.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

โค๏ธ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Aug 28 '25 07:08 coderabbitai[bot]

please verify your commits

thomas-nguy avatar Aug 29 '25 06:08 thomas-nguy

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 35.47%. Comparing base (a3c2f70) to head (b9e3c9f). :warning: Report is 120 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1860       +/-   ##
===========================================
+ Coverage   16.87%   35.47%   +18.60%     
===========================================
  Files          72      127       +55     
  Lines        6163     9730     +3567     
===========================================
+ Hits         1040     3452     +2412     
- Misses       5000     5910      +910     
- Partials      123      368      +245     

see 121 files with indirect coverage changes

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Aug 29 '25 06:08 codecov[bot]

Executed and signed. Please review again.

zhedazijingang avatar Sep 05 '25 09:09 zhedazijingang