docs: improvement of grammar

[CreeptoGengar]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 627cab1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This change updates documentation pages with grammar and style corrections throughout various sections. The primary substantive update involves MerkleTree method signatures, which now require an additional hash function parameter. Specifically, the setup() and push() methods have been modified to accept a hash function argument alongside their existing parameters. Supporting example code has been updated to reflect these signature changes, including the introduction of a new _hashFn implementation. Additionally, prose improvements address subject-verb agreement and general readability across documentation sections covering contracts and data structures.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description Check	❓ Inconclusive	No pull request description was provided by the author. While the lenient evaluation criteria allow descriptions that are not off-topic, the complete absence of a description makes it impossible to verify whether an explanation related to the changeset was intended. The criteria do not explicitly address how to evaluate completely missing descriptions versus descriptions that exist but are off-topic.	Consider adding a brief description of the changes to provide clarity on the scope of work, particularly to explain that the pull request includes not only grammar improvements but also updates to MerkleTree method signatures and their usage in documentation examples.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "docs: improvement of grammar" is directly related to the changeset, which includes grammar and style corrections in two documentation files (eoa-delegation.adoc and utilities.adoc). In eoa-delegation.adoc, grammar is corrected ("avoids replayability" → "avoid replayability"), and in utilities.adoc, multiple grammar and style tweaks are applied ("Contracts provides" → "Contracts provide" and similar refinements). While utilities.adoc also includes updates to MerkleTree method signatures with new hash function parameters, the grammar improvements are a significant and real aspect of the overall changes that the title accurately captures.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/modules/ROOT/pages/utilities.adoc (1)

293-295: Clarify transition between basic and custom hashing examples.

The documentation now shifts from a basic MerkleTree example (without custom hash functions) to emphasizing custom hash functions as a sensitive operation. Consider adding an introductory sentence between lines 292 and 293 (after "These functions allow developers to...") that explicitly states: "For most use cases, the default hashing is sufficient; however, for advanced scenarios..."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8631702 and 627cab1.

📒 Files selected for processing (2)

• docs/modules/ROOT/pages/eoa-delegation.adoc (1 hunks)
• docs/modules/ROOT/pages/utilities.adoc (3 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). (9)

• GitHub Check: Redirect rules - solidity-contracts
• GitHub Check: Header rules - solidity-contracts
• GitHub Check: Pages changed - solidity-contracts
• GitHub Check: tests-upgradeable
• GitHub Check: tests
• GitHub Check: coverage
• GitHub Check: slither
• GitHub Check: tests-foundry
• GitHub Check: halmos

🔇 Additional comments (3)

docs/modules/ROOT/pages/eoa-delegation.adoc (1)

55-56: Correct subject-verb agreement.

The change from "avoids" to "avoid" properly aligns the verb with its plural subject "signatures."

docs/modules/ROOT/pages/utilities.adoc (2)

258-258: Documentation prose improvements approved.

The grammar and readability improvements across the Structures, Packing, and custom hashing functions sections enhance clarity without changing technical meaning. Changes maintain consistency with the overall documentation style.

Also applies to: 295-295, 349-349, 351-351

---

283-284: ****

The documentation is accurate. The MerkleTree.sol source confirms that both setup() and push() have function overloads: one without the hash function parameter (defaulting to Hashes.commutativeKeccak256) and one accepting a custom hash function. The two examples in utilities.adoc correctly demonstrate both use cases—basic usage without the parameter, then advanced usage with it—and the intermediate text properly explains that custom hashing functions can be passed as optional parameters.