Fix Typos in ADR-004 and ADR-012 Documentation Files #4079
Conversation
Dimitrolito
requested review from
staheri14 and
rach-id
and removed request for
a team
📝 WalkthroughWalkthroughThe pull request includes updates to two documentation files: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
docs/architecture/adr-004-qgb-relayer-security.md(1 hunks)docs/architecture/adr-012-sequence-length-encoding.md(1 hunks)
🔇 Additional comments (1)
docs/architecture/adr-004-qgb-relayer-security.md (1)
21-21: LGTM: Correct hyphenation of "up-to-date"
The hyphenation in "up-to-date" is grammatically correct when used as a predicate adjective.
| - 4 bytes is capable of storing an uint32. An uint32 can contain a max sequence length of 4,294,967,296 bytes. In other words, an uint32 works up until 4GiB blocks. To put this into context, this max sequence length is hit with 1024 byte share size and max square size of 2048. | ||
| - 8 bytes is capable of storing an uint64. An uint64 can contain a max sequence length of 18,446,744,073,709,551,615 bytes so pebibyte scale. |
There was a problem hiding this comment.
Revert article usage before "uint32/uint64"
The change from "a uint32" to "an uint32" is incorrect. Articles should be chosen based on the pronunciation, not spelling. Since "uint32" is pronounced as "you-int-32" (starting with a consonant sound), it should use "a" rather than "an".
Please revert to:
- "a uint32" (not "an uint32")
- "a uint64" (not "an uint64")
There was a problem hiding this comment.
@Dimitrolito coderabbitai is using a better model than you are
|
closing as these updates are incorrect please review the changes suggested by whatever model you're using @Dimitrolito |
This pull request addresses several typos and minor corrections in the documentation files:
adr-004-qgb-relayer-security.md, changed "up to date" to "up-to-date".adr-012-sequence-length-encoding.md, corrected "a uint32" and "a uint64" to "an uint32" and "an uint64", respectively.These updates improve clarity and grammatical accuracy in the documentation.