Skip to content

Commit 78693c5

Browse files
committed
tweak: natspec
1 parent 67978c6 commit 78693c5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

contracts/utils/EmergencyBrake.sol

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ interface IEmergencyBrake {
1212
function terminate(address target, address[] memory contacts, bytes4[][] memory permissions) external;
1313
}
1414

15-
/// @dev EmergencyBrake allows to plan for and execute isolation transactions that remove access permissions for
16-
/// a target contract from a series of contacts. In an permissioned environment can be used for pausing components.
15+
/// @dev EmergencyBrake allows to plan for and execute transactions that remove access permissions for a target
16+
/// contract. In an permissioned environment this can be used for pausing components.
1717
/// All contracts in scope of emergency plans must grant ROOT permissions to EmergencyBrake. To mitigate the risk
1818
/// of governance capture, EmergencyBrake has very limited functionality, being able only to revoke existing roles
1919
/// and to restore previously revoked roles. Thus EmergencyBrake cannot grant permissions that weren't there in the
@@ -41,7 +41,7 @@ contract EmergencyBrake is AccessControl, IEmergencyBrake {
4141
// Granting roles (plan, cancel, execute, restore, terminate) is reserved to ROOT
4242
}
4343

44-
/// @dev Register an isolation transaction
44+
/// @dev Register an access removal transaction
4545
function plan(address target, address[] memory contacts, bytes4[][] memory permissions)
4646
external override auth
4747
returns (bytes32 txHash)
@@ -62,7 +62,7 @@ contract EmergencyBrake is AccessControl, IEmergencyBrake {
6262
emit Planned(txHash, target, contacts, permissions);
6363
}
6464

65-
/// @dev Erase a planned isolation transaction
65+
/// @dev Erase a planned access removal transaction
6666
function cancel(address target, address[] memory contacts, bytes4[][] memory permissions)
6767
external override auth
6868
{
@@ -73,7 +73,7 @@ contract EmergencyBrake is AccessControl, IEmergencyBrake {
7373
emit Cancelled(txHash, target, contacts, permissions);
7474
}
7575

76-
/// @dev Execute an isolation transaction
76+
/// @dev Execute an access removal transaction
7777
function execute(address target, address[] memory contacts, bytes4[][] memory permissions)
7878
external override auth
7979
{

0 commit comments

Comments
 (0)