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: fix spelling errors #19957

Merged
merged 1 commit into from
Apr 4, 2024
Merged

chore: fix spelling errors #19957

merged 1 commit into from
Apr 4, 2024

Conversation

github-prbot
Copy link
Contributor

@github-prbot github-prbot commented Apr 4, 2024

This PR fixes typos in the codebase.
Please review it, and merge if everything is fine.
If there are proto changes, run make proto-gen and commit the changes.

Summary by CodeRabbit

  • Bug Fixes
    • Corrected a typo in the log messages related to epoch information.

@github-prbot github-prbot requested a review from a team as a code owner April 4, 2024 14:48
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Walkthrough

Walkthrough

The change involves a minor correction in a log message within the BeginBlocker function of the Keeper type located in the abci.go file. Specifically, a typo was fixed to ensure the accuracy of the error message displayed when there's an issue setting epoch information.

Changes

File Change Summary
.../keeper/abci.go Corrected a typo in the log message from "Error set epoch infor" to "Error set epoch info."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between edd1c71 and dcd8444.
Files selected for processing (1)
  • x/epochs/keeper/abci.go (1 hunks)
Additional Context Used
Path-based Instructions (1)
x/epochs/keeper/abci.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)
x/epochs/keeper/abci.go (1)

73-73: The typo correction in the log message enhances the clarity and readability. Good catch!

Comment on lines 70 to 76
}
err = k.EpochInfo.Set(ctx, epochInfo.Identifier, epochInfo)
if err != nil {
logger.Error(fmt.Sprintf("Error set epoch infor with identifier %s epoch number %d", epochInfo.Identifier, epochInfo.CurrentEpoch))
logger.Error(fmt.Sprintf("Error set epoch info with identifier %s epoch number %d", epochInfo.Identifier, epochInfo.CurrentEpoch))
return false, nil
}
if err := k.environment.BranchService.Execute(ctx, func(ctx context.Context) error {
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [50-50]

Consider handling the error from k.environment.EventService.EventManager(ctx).Emit(&types.EventEpochEnd{...}) instead of ignoring it. Ignoring errors can lead to unnoticed issues.

- if err != nil {
-     return false, nil
- }
+ if err != nil {
+     logger.Error(fmt.Sprintf("Failed to emit EventEpochEnd for identifier %s epoch number %d: %v", epochInfo.Identifier, epochInfo.CurrentEpoch, err))
+     return false, err
+ }

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [58-58]

Ignoring errors from k.AfterEpochEnd and k.BeforeEpochStart might be intentional to avoid halting the chain, but consider at least logging the error to aid in debugging.

- // purposely ignoring the error here not to halt the chain if the hook fails
+ // purposely ignoring the error here not to halt the chain if the hook fails
+ logger.Error(fmt.Sprintf("Error after epoch end with identifier %s epoch number %d: %v", epochInfo.Identifier, epochInfo.CurrentEpoch, err))

@julienrbrt julienrbrt added this pull request to the merge queue Apr 4, 2024
Merged via the queue into main with commit 558c950 Apr 4, 2024
61 of 63 checks passed
@julienrbrt julienrbrt deleted the bot/fix-typos branch April 4, 2024 16:19
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 8, 2024
* main: (45 commits)
  build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913)
  build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929)
  test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964)
  refactor(x/bank)!: remove Address.String() (cosmos#19954)
  build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930)
  fix(x/epochs): Fix init genesis (cosmos#19958)
  feat(core,runtime): transaction service (exec mode) (cosmos#19953)
  fix(x/authz): non utf-8 characters in logs (cosmos#19923)
  build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960)
  chore: fix spelling errors (cosmos#19957)
  fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)
  refactor(types): loosen module.AppModule interface (cosmos#19951)
  feat(core): add `TxValidator` interface (cosmos#19950)
  build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947)
  feat(x/epochs): upstream osmosis epoch module (cosmos#19697)
  build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928)
  refactor(x/genutil)!: remove Address.String() (cosmos#19926)
  docs(x/mint): Fix inconsistency in mint docs  (cosmos#19915)
  build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920)
  feat: Integrate grpc configuration into client.toml (cosmos#19905)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants