docs(governor): correct Natspec to reference ICompoundTimelock

[phrwlk]

• Replace incorrect {TimelockController} mentions with {ICompoundTimelock} in GovernorTimelockCompound.sol Natspec.
• Clarify the TimelockChange event description to avoid confusion with TimelockController.

Rationale: This module integrates with Compound’s Timelock via ICompoundTimelock; prior wording was a copy-paste error that could mislead integrators and reviewers. No logic changes.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7998461

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

Documentation comments in the GovernorTimelockCompound.sol contract were updated to reference ICompoundTimelock instead of TimelockController for accurate timelock semantics. Event description wording was also adjusted. No functional changes, public API modifications, control flow alterations, or error handling updates were introduced.

Suggested labels

ignore-changeset, typo

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely summarizes the main change: correcting Natspec documentation in GovernorTimelockCompound.sol to reference the correct ICompoundTimelock interface instead of TimelockController.
Description check	✅ Passed	The description clearly explains what was changed (Natspec corrections), provides rationale (copy-paste error that could mislead integrators), and specifies that no logic changes were made, all directly related to the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6308fdc and 7998461.

📒 Files selected for processing (1)

• contracts/governance/extensions/GovernorTimelockCompound.sol (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). (9)

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

🔇 Additional comments (3)

contracts/governance/extensions/GovernorTimelockCompound.sol (3)

17-19: Correct Natspec references to ICompoundTimelock.

The documentation now accurately references {ICompoundTimelock} instead of {TimelockController}, properly reflecting the contract's actual integration with Compound's timelock interface. This resolves the copy-paste error and clarifies to integrators and reviewers the correct interface in use.

---

25-25: Clarified event description for improved semantics.

The event description now uses generic wording—"timelock used for proposal execution is modified"—rather than referencing a specific implementation. This is clearer and avoids confusion with TimelockController.

---

1-165: Codebase consistency verified.

Search of all Solidity governance files confirms no stale or incorrect references to TimelockController exist in Compound timelock integration contexts. The GovernorTimelockControl.sol and GovernorTimelockCompound.sol implementations are properly separated and correctly use their respective timelock types (TimelockController and ICompoundTimelock).

---

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.}