Skip to content

Conversation

@letmehateu
Copy link
Contributor

Fixes #????
Updates the governance documentation to use ethers.js v6 API instead of the deprecated v5 API.

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@letmehateu letmehateu requested a review from a team as a code owner December 29, 2025 19:01
@changeset-bot
Copy link

changeset-bot bot commented Dec 29, 2025

⚠️ No Changeset found

Latest commit: c1b38e7

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
Copy link
Contributor

coderabbitai bot commented Dec 29, 2025

Walkthrough

The change updates a code example in the documentation to reflect an API change in the ethers library. Specifically, it replaces ethers.utils.id() with ethers.id() for computing a description hash in a queue example. The function behavior remains identical; only the import path is modified to use the newer API surface. No other documentation content or logic is altered.

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: updating ethers.js v5 API usage to v6 in the governance documentation example.
Description check ✅ Passed The description clearly states the purpose of updating governance documentation from ethers.js v5 to v6 API, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 001169b and c1b38e7.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/governance.adoc
⏰ 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: tests-foundry
  • GitHub Check: coverage
  • GitHub Check: slither
  • GitHub Check: halmos
🔇 Additional comments (1)
docs/modules/ROOT/pages/governance.adoc (1)

155-155: Correct ethers.js v6 API usage.

The ethers.id() function is the correct v6 API for computing the hash of UTF-8 data, making this replacement of the v5 ethers.utils.id() pattern accurate and idiomatic for v6. The function behavior remains identical; only the namespace path has been modernized per the v6 API surface simplification.


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

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

@Amxx Amxx changed the base branch from master to typo-fixes January 5, 2026 13:29
@Amxx Amxx added documentation Inline comments, guides, and examples. ignore-changeset typo labels Jan 5, 2026
@Amxx Amxx merged commit 750453e into OpenZeppelin:typo-fixes Jan 5, 2026
22 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Inline comments, guides, and examples. ignore-changeset typo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants