Skip to content

docs(governor): correct Natspec to reference ICompoundTimelock #6114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −3
Open

docs(governor): correct Natspec to reference ICompoundTimelock #6114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions contracts/governance/extensions/GovernorTimelockCompound.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ import {SafeCast} from "../../utils/math/SafeCast.sol";
* the admin of the timelock for any operation to be performed. A public, unrestricted,
* {GovernorTimelockCompound-__acceptAdmin} is available to accept ownership of the timelock.
*
* Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
* the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
* Using this model means the proposal will be operated by the {ICompoundTimelock} and not by the {Governor}. Thus,
* the assets and permissions must be attached to the {ICompoundTimelock}. Any asset sent to the {Governor} will be
* inaccessible from a proposal, unless executed via {Governor-relay}.
*/
abstract contract GovernorTimelockCompound is Governor {
ICompoundTimelock private _timelock;

/**
* @dev Emitted when the timelock controller used for proposal execution is modified.
* @dev Emitted when the timelock used for proposal execution is modified.
*/
event TimelockChange(address oldTimelock, address newTimelock);

Expand Down
Loading