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

fix: typos #4141

Merged
merged 2 commits into from
Dec 19, 2024
Merged

fix: typos #4141

merged 2 commits into from
Dec 19, 2024

Conversation

romashka-btc
Copy link
Contributor

Fix: Corrected typos in documentation files

Changes

  • docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md:180: "Parital" corrected to "Partial".
  • docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md:176: "collum" corrected to "column".

Purpose

  • Improved documentation accuracy and professionalism.

@romashka-btc romashka-btc requested a review from a team as a code owner December 18, 2024 18:43
@romashka-btc romashka-btc requested review from cmwaters and rach-id and removed request for a team December 18, 2024 18:43
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

📝 Walkthrough

Walkthrough

The pull request involves updating the Architecture Decision Record (ADR) document adr-009-non-interactive-default-rules-for-reduced-padding.md. The primary focus is on modifying the non-interactive default rules for message padding, specifically changing how message starting positions are determined within square sizes. The document explores the implications of these changes on message inclusion proofs, padding efficiency, and proof sizes. Additionally, minor textual corrections were made to improve document clarity.

Changes

File Change Summary
docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md - Updated message starting position rules
- Analyzed impact on message padding and proof sizes
- Corrected textual errors (e.g., "collum" to "column")
- Noted supersession by ADR-013

Suggested Labels

external

Suggested Reviewers

  • staheri14
  • ninabarbakadze
  • rootulp
  • rach-id

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
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

🧹 Nitpick comments (1)
docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md (1)

176-176: Consider adding a comma after "Therefore"

For better readability, consider adding a comma after "Therefore":

-Light Nodes have additional access to row and column roots from the Data Availability header. Therefore we can discard any blue nodes to the `DataRoot` from the analysis.
+Light Nodes have additional access to row and column roots from the Data Availability header. Therefore, we can discard any blue nodes to the `DataRoot` from the analysis.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~176-~176: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...oots from the Data Availability header. Therefore we can discard any blue nodes to the `D...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f3b196 and 87817a4.

📒 Files selected for processing (1)
  • docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md

[uncategorized] ~176-~176: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...oots from the Data Availability header. Therefore we can discard any blue nodes to the `D...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

🔇 Additional comments (1)
docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md (1)

180-180: LGTM! Fixed typo from "Parital" to "Partial"

The correction improves document clarity.

@rootulp rootulp changed the title Typ+cod/fix fix: typos Dec 18, 2024
@rootulp rootulp enabled auto-merge (squash) December 18, 2024 19:09
@rootulp rootulp merged commit 2e28bdd into celestiaorg:main Dec 19, 2024
29 of 30 checks passed
Copy link

gitpoap-bot bot commented Dec 19, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

GitPOAP: 2024 Celestia Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

@coderabbitai coderabbitai bot mentioned this pull request Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants