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: correct command of binary file #3467

Merged
merged 1 commit into from
May 12, 2024
Merged

Conversation

tnv1
Copy link
Contributor

@tnv1 tnv1 commented May 12, 2024

Overview

@tnv1 tnv1 requested a review from a team as a code owner May 12, 2024 09:37
@tnv1 tnv1 requested review from rootulp and evan-forbes and removed request for a team May 12, 2024 09:37
Copy link
Contributor

coderabbitai bot commented May 12, 2024

Walkthrough

Walkthrough

The update involves a modification in the command name used in the project documentation, specifically in the README.md file. The command celestia-app tx blob PayForBlobs has been renamed to celestia-appd tx blob PayForBlobs, reflecting a change in the command's syntax.

Changes

File Path Change Summary
x/blob/README.md Renamed command from celestia-app tx blob PayForBlobs to celestia-appd tx blob PayForBlobs.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between c9707a7 and d4922d8.
Files selected for processing (1)
  • x/blob/README.md (1 hunks)
Additional Context Used
LanguageTool (4)
x/blob/README.md (4)

Near line 14: Possible typo: you repeated a word
Context: ...the network, a block producer separates the the sdk.Tx from the blob(s). Both compone...


Near line 25: Consider isolating this adverbial phrase with commas.
Context: ...ares that compose their original data do in fact exist in a particular block. > TODO: l...


Near line 31: Did you mean “its” (the possessive pronoun)?
Context: ...State The blob module doesn't maintain it's own state outside of two params. Meanin...


Near line 135: Unpaired symbol: ‘]’ seems to be missing
Context: ...ing the steps specified above in [Generating the Share Commitment](...

Additional comments not posted (1)
x/blob/README.md (1)

183-183: Command update in the usage section is correct and reflects the new executable name.

Ensure that all references to the old command are updated across the documentation to maintain consistency.


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 replies 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 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/schema.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.

@celestia-bot celestia-bot requested a review from a team May 12, 2024 09:38
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: 0

Out of diff range and nitpick comments (4)
x/blob/README.md (4)

Line range hint 14-14: Repeated word "the" detected.

- a block producer separates the the `sdk.Tx` from the blob(s).
+ a block producer separates the `sdk.Tx` from the blob(s).

Line range hint 25-25: Consider adding commas around the adverbial phrase for clarity.

- shares that compose their original data do in fact exist in a particular block.
+ shares that compose their original data do, in fact, exist in a particular block.

Line range hint 31-31: Grammatical error: "it's" should be "its" when indicating possession.

- The blob module doesn't maintain it's own state outside of two params.
+ The blob module doesn't maintain its own state outside of two params.

Line range hint 135-135: Unpaired symbol: ‘]’ seems to be missing in the markdown link.

- in [Generating the Share Commitment](./README.md#generating-the-sharecommitment)
+ in [Generating the Share Commitment](./README.md#generating-the-share-commitment)

Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

omg how did this typo survive for so long

@evan-forbes evan-forbes merged commit 3930165 into celestiaorg:main May 12, 2024
34 checks passed
@tnv1 tnv1 deleted the doc branch May 13, 2024 06:30
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.

3 participants