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

docs: update cometbft db code reference link #22166

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

tutufen
Copy link
Contributor

@tutufen tutufen commented Oct 8, 2024

Description

Since prefix_db.go has been removed from cometbft to cometbft-db at this commit, the original link couldn't work now,we should update them

Summary by CodeRabbit

  • Documentation

    • Updated comments to reflect new URLs for the Iterator and ReverseIterator methods in the Store and prefixstore packages, ensuring accurate references to the cometbft-db repository.
  • Bug Fixes

    • No functional changes were made; all existing methods continue to operate as intended without any alterations to their logic or signatures.

Copy link
Contributor

coderabbitai bot commented Oct 8, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates comments in the Store struct and its associated methods across multiple packages to reference a specific version of the cometbft-db repository instead of the previous general cometbft repository. The functionality and logic of the methods, including NewStore, Get, Has, Set, Delete, Iterator, and ReverseIterator, remain unchanged, as do the signatures and internal logic of the prefixIterator struct and its methods.

Changes

File Path Change Summary
store/prefix/store.go Updated comments to reference new URLs for the cometbft-db repository.
x/accounts/internal/prefixstore/prefixstore.go Updated comments to reference new URLs for the cometbft-db repository.
x/group/internal/orm/prefixstore/prefixstore.go Updated comments to reference specific file and line numbers in the cometbft-db repository.

Possibly related PRs

Suggested labels

C:x/consensus, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2de90b5 and 887b43b.

📒 Files selected for processing (3)
  • store/prefix/store.go (4 hunks)
  • x/accounts/internal/prefixstore/prefixstore.go (4 hunks)
  • x/group/internal/orm/prefixstore/prefixstore.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • store/prefix/store.go
  • x/accounts/internal/prefixstore/prefixstore.go
  • x/group/internal/orm/prefixstore/prefixstore.go

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

thanks!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 8, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Oct 8, 2024
Merged via the queue into cosmos:main with commit 8117f2c Oct 8, 2024
71 of 75 checks passed
mergify bot pushed a commit that referenced this pull request Oct 8, 2024
(cherry picked from commit 8117f2c)

# Conflicts:
#	store/prefix/store.go
julienrbrt added a commit that referenced this pull request Oct 8, 2024
@tutufen tutufen deleted the refactor/prefixdb-doc branch October 8, 2024 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:Store C:x/accounts C:x/group
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants