docs: fix grammar and clarity in documentation #5909
+6
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Reviewer's guide (collapsed on small PRs)Reviewer's GuideMinor grammar and clarity improvements applied across several AsciiDoc documentation files, including insertion of missing prepositions, tense corrections, possessive adjustments, and phrasing refinements. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughEditorial grammar corrections across several documentation pages. No code, logic, APIs, or control flow were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/modules/ROOT/pages/utilities.adoc (2)
11-11: Prefer gender‑neutral and more precise wording (“control” vs “owner”).-At a high level, signatures are a set of cryptographic algorithms that allow for a _signer_ to prove himself the owner of a _private key_ used to authorize a piece of information (generally a transaction or `UserOperation`). Natively, the EVM supports the Elliptic Curve Digital Signature Algorithm (https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm[ECDSA]) using the secp256k1 curve, however other signature algorithms such as P256 and RSA are supported. +At a high level, signatures are a set of cryptographic algorithms that allow a _signer_ to prove they control a _private key_ used to authorize a piece of information (generally a transaction or `UserOperation`). Natively, the EVM supports the Elliptic Curve Digital Signature Algorithm (https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm[ECDSA]) using the secp256k1 curve; other signature algorithms such as P256 and RSA are also supported.
191-191: Tighten phrasing (“helps with” > “helps to do”).-In Solidity, it's frequently helpful to know whether or not a contract supports an interface you'd like to use. ERC-165 is a standard that helps to do runtime interface detection. Contracts provide helpers both for implementing ERC-165 in your contracts and querying other contracts: +In Solidity, it's frequently helpful to know whether a contract supports an interface you'd like to use. ERC-165 is a standard that helps with runtime interface detection. Contracts provide helpers both for implementing ERC-165 in your contracts and querying other contracts:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
docs/modules/ROOT/pages/access-control.adoc(1 hunks)docs/modules/ROOT/pages/erc4626.adoc(1 hunks)docs/modules/ROOT/pages/governance.adoc(1 hunks)docs/modules/ROOT/pages/utilities.adoc(3 hunks)
🔇 Additional comments (4)
docs/modules/ROOT/pages/governance.adoc (1)
164-164: LGTM — correct verb tense.docs/modules/ROOT/pages/erc4626.adoc (1)
178-179: LGTM — possessive fix reads correctly and matches the math above.docs/modules/ROOT/pages/access-control.adoc (1)
46-46: LGTM — clearer infinitive form.docs/modules/ROOT/pages/utilities.adoc (1)
259-259: LGTM — correct subject–verb agreement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
access-control.adoc – added missing "to" in role description.
erc4626.adoc – fixed grammar ("attacker’s loss").
governance.adoc – corrected "ran" → "run".
utilities.adoc – improved phrasing:
"prove himself owner" → "prove himself the owner".
"helps do" → "helps to do".
"Contracts provides" → "Contracts provide".
Summary by Sourcery
Improve grammar and clarity in project documentation by addressing minor typos and phrasing issues in multiple AsciiDoc files.
Documentation:
Summary by CodeRabbit