-
Notifications
You must be signed in to change notification settings - Fork 329
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 in documentation and Code comments #4165
base: main
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughThis pull request encompasses minor documentation and comment improvements across multiple files. The changes include a hyphen correction in the README.md usage instructions, a grammatical fix in the Changes
Sequence DiagramsequenceDiagram
participant Validator
participant Application
participant BlockProducer
Validator->>Application: PrepareProposal
Application-->>BlockProducer: Validate Block Data
BlockProducer->>Application: ProcessProposal
Application->>Validator: Validate Proposal
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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-001-abci++-adoption.md (1)
331-331
: Consider a more concise phrasingThe sentence could be made more concise by removing "of" while maintaining its technical clarity.
-Ideally, we would move all of the code that computes erasure encoding to the app. +Ideally, we would move all the code that computes erasure encoding to the app.🧰 Tools
🪛 LanguageTool
[style] ~331-~331: Consider removing “of” to be more concise
Context: ...a remains there. Ideally, we would move all of the code that computes erasure encoding to ...(ALL_OF_THE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md
(1 hunks)app/genesis.go
(1 hunks)docs/architecture/adr-001-abci++-adoption.md
(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- README.md
- app/genesis.go
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-001-abci++-adoption.md
[style] ~331-~331: Consider removing “of” to be more concise
Context: ...a remains there. Ideally, we would move all of the code that computes erasure encoding to ...
(ALL_OF_THE)
This pull request addresses several typographical errors in the Celestia app repository:
These changes improve the readability and professionalism of the documentation and code comments while maintaining technical clarity.