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: stork price state correct example symbol #234

Closed
wants to merge 2 commits into from

Conversation

danidomi
Copy link

@danidomi danidomi commented Aug 23, 2024

fix stork price state with a correct example symbol always a pair with Base and Quote (BTCUSDT)

Summary by CodeRabbit

  • Documentation
    • Updated the comment for the symbol field in the price state to clarify the expected format, changing from "e.g. BTC" to "e.g. BTCUSDT" to indicate a trading pair format.

@danidomi danidomi changed the title F/stork price state correct example symbol chore: stork price state correct example symbol Aug 23, 2024
Copy link

coderabbitai bot commented Aug 23, 2024

Walkthrough

The update modifies the oracle.proto file by refining the comment for the symbol field in the StorkPriceState message. The comment now emphasizes that the price symbol should represent a trading pair, illustrated by the example "BTCUSDT" instead of just "BTC." This change clarifies expectations for the input format while leaving the data structure unchanged.

Changes

File Change Summary
proto/injective/oracle/v1beta1/oracle.proto Updated comment for symbol field in StorkPriceState to clarify expected format.

Poem

In the realm of code where rabbits play,
A symbol's meaning found a brighter way.
From "BTC" to pairs like "BTCUSDT,"
Clarity blooms, as clear as can be!
Hops of joy in lines so neat,
A tidy code makes life so sweet! 🐇✨


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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

@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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b7a68cc and 30ec292.

Files selected for processing (1)
  • proto/injective/oracle/v1beta1/oracle.proto (1 hunks)
Files skipped from review due to trivial changes (1)
  • proto/injective/oracle/v1beta1/oracle.proto

@danidomi danidomi closed this Aug 23, 2024
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.

2 participants