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: remove comments about "counter" in NMT cacher #3071

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Jan 31, 2024

Closes #3070

There are no instances of counter in nmt_caching.go. paths.go has a counter field but that doesn't seem immediately relevant to where these comments are so proposal to remove them.

@rootulp rootulp self-assigned this Jan 31, 2024
@rootulp rootulp marked this pull request as ready for review January 31, 2024 20:19
Copy link
Contributor

coderabbitai bot commented Jan 31, 2024

Walkthrough

Walkthrough

The changes involve updating documentation and simplifying logic within the nmt_caching.go file of the Celestia application. Outdated references to a non-existent "counter" field were removed, and documentation was clarified to better reflect the current state and future plans for the code, indicating a focus on maintaining clean and accurate code documentation and structure.

Changes

File Change Summary
pkg/inclusion/nmt_caching.go Updated EDSSubTreeRootCacher type's documentation comments; simplified logic in Constructor method by removing comments about counter field.

Assessment against linked issues

Objective Addressed Explanation
Misleading comments about "counter" in NMT cacher (#3070)

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

go.work.sum Outdated Show resolved Hide resolved
go.work.sum Show resolved Hide resolved
go.work.sum Show resolved Hide resolved
go.work.sum Outdated Show resolved Hide resolved
pkg/inclusion/nmt_caching.go Show resolved Hide resolved
pkg/inclusion/nmt_caching.go Show resolved Hide resolved
@rootulp rootulp enabled auto-merge (squash) February 2, 2024 22:20
@celestia-bot celestia-bot requested a review from a team February 5, 2024 19:02
@rootulp
Copy link
Collaborator Author

rootulp commented Feb 6, 2024

Ping @evan-forbes @cmwaters @staheri14

@rootulp rootulp merged commit 4daf069 into celestiaorg:main Feb 6, 2024
29 of 33 checks passed
@rootulp rootulp deleted the rp/remove-counter-docs branch February 6, 2024 15:11
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.

Misleading comments about "counter" in NMT cacher
3 participants