-
Notifications
You must be signed in to change notification settings - Fork 4k
docs: fix typos and improve documentation clarity #24978
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
Conversation
📝 WalkthroughWalkthroughA series of documentation files were updated to correct various typographical errors, including spelling mistakes in prose, comments, and a protobuf message field name. No logic, control flow, or functional code was changed. Only editorial improvements were made to enhance clarity and correctness in the documentation and message definitions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Note ⚡️ Unit Test Generation - BetaCodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
CodeRabbit Configuration File (
|
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 (2)
docs/architecture/adr-028-public-key-addresses.md (1)
322-322
: Minor grammar issue – “kept” → “keep”The verb tense is off. Recommend:
-* we will need to set a pre-image prefix for module addresses to kept them in 32-byte space: `hash(hash('module') + module_key)` +* we will need to set a pre-image prefix for module addresses to keep them within the 32-byte space: `hash(hash('module') + module_key)`docs/architecture/adr-059-test-scopes.md (1)
151-151
: Sentence reads awkwardlySwap “will” for “with” to fix grammar:
-The SDK uses an application will only the required modules for the tests. +The SDK uses an application with only the required modules for the tests.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
⛔ Files ignored due to path filters (1)
types/tx/tx.pb.go
is excluded by!**/*.pb.go
,!**/*.pb.go
📒 Files selected for processing (8)
docs/architecture/adr-006-secret-store-replacement.md
(1 hunks)docs/architecture/adr-010-modular-antehandler.md
(1 hunks)docs/architecture/adr-028-public-key-addresses.md
(1 hunks)docs/architecture/adr-042-group-module.md
(1 hunks)docs/architecture/adr-043-nft-module.md
(1 hunks)docs/architecture/adr-059-test-scopes.md
(1 hunks)docs/docs/learn/advanced/01-transactions.md
(1 hunks)docs/docs/learn/advanced/05-encoding.md
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Summary
🔇 Additional comments (6)
docs/architecture/adr-010-modular-antehandler.md (1)
145-145
: Typo correction LGTMFixing the misspelled
return
clarifies the example and eliminates potential copy-paste errors. Nothing else to address here.docs/architecture/adr-042-group-module.md (1)
25-25
: Typo fix looks good
ans
→and
reads correctly.docs/architecture/adr-006-secret-store-replacement.md (1)
24-24
: Spelling correction confirmedChanging “rouge software” → “rogue software” improves clarity.
docs/docs/learn/advanced/05-encoding.md (1)
60-60
: Spelling fix acknowledged“annote” → “annotate” is correct.
docs/docs/learn/advanced/01-transactions.md (1)
77-80
: Typo fix looks good – no further action.Correcting “Morever” to “Moreover” improves readability and requires no additional changes.
docs/architecture/adr-043-nft-module.md (1)
155-160
: Field-name correction acknowledged — please ensure implementation parity.Renaming
reveiver
→receiver
aligns the ADR with conventional spelling. Double-check that:
- The actual
MsgSend
protobuf definition underproto/
already usesreceiver
.- Any code samples, tests, or generated clients refer to the updated field.
A quick grep across the repo will confirm there are no lingering misspellings.
Description:
This pull request addresses several minor typos and improves the clarity of documentation across multiple files.
Summary by CodeRabbit