Update comments

LiskHQ · Jun 11, 2024 · 8a21d21 · 8a21d21
1 parent 69e0594
commit 8a21d21
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 17 deletions.
diff --git a/src/L2/paused/L2GovernorPaused.sol b/src/L2/paused/L2GovernorPaused.sol
@@ -12,11 +12,12 @@ contract L2GovernorPaused is L2Governor {
     /// @notice Setting global params.
     function initializePaused() public reinitializer(2) { }
 
+    /// @notice Marking version as paused.
     function version() public pure virtual override returns (string memory) {
         return "1.0.0-paused";
     }
 
-    /// @notice Override the cancel function to prevent staking from being processed.
+    /// @notice Override the cancel function to pause Governor interactions.
     function cancel(
         address[] memory,
         uint256[] memory,
@@ -31,22 +32,22 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the castVote function to prevent staking from being processed.
+    /// @notice Override the castVote function to pause Governor interactions.
     function castVote(uint256, uint8) public virtual override returns (uint256) {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the castVoteBySig function to prevent staking from being processed.
+    /// @notice Override the castVoteBySig function to pause Governor interactions.
     function castVoteBySig(uint256, uint8, address, bytes memory) public virtual override returns (uint256) {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the castVoteWithReason function to prevent staking from being processed.
+    /// @notice Override the castVoteWithReason function to pause Governor interactions.
     function castVoteWithReason(uint256, uint8, string calldata) public virtual override returns (uint256) {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the castVoteWithReasonAndParams function to prevent staking from being processed.
+    /// @notice Override the castVoteWithReasonAndParams function to pause Governor interactions.
     function castVoteWithReasonAndParams(
         uint256,
         uint8,
@@ -61,7 +62,7 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the castVoteWithReasonAndParamsBySig function to prevent staking from being processed.
+    /// @notice Override the castVoteWithReasonAndParamsBySig function to pause Governor interactions.
     function castVoteWithReasonAndParamsBySig(
         uint256,
         uint8,
@@ -78,7 +79,7 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the execute function to prevent staking from being processed.
+    /// @notice Override the execute function to pause Governor interactions.
     function execute(
         address[] memory,
         uint256[] memory,
@@ -94,7 +95,7 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the propose function to prevent staking from being processed.
+    /// @notice Override the propose function to pause Governor interactions.
     function propose(
         address[] memory,
         uint256[] memory,
@@ -109,7 +110,7 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the queue function to prevent staking from being processed.
+    /// @notice Override the queue function to pause Governor interactions.
     function queue(
         address[] memory,
         uint256[] memory,
@@ -124,27 +125,27 @@ contract L2GovernorPaused is L2Governor {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the relay function to prevent staking from being processed.
+    /// @notice Override the relay function to pause Governor interactions.
     function relay(address, uint256, bytes memory) public payable virtual override {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the setProposalThreshold function to prevent staking from being processed.
+    /// @notice Override the setProposalThreshold function to pause Governor interactions.
     function setProposalThreshold(uint256) public virtual override {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the setVotingDelay function to prevent staking from being processed.
+    /// @notice Override the setVotingDelay function to pause Governor interactions.
     function setVotingDelay(uint48) public virtual override {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the setVotingPeriod function to prevent staking from being processed.
+    /// @notice Override the setVotingPeriod function to pause Governor interactions.
     function setVotingPeriod(uint32) public virtual override {
         revert("L2GovernorPaused: Governor is paused");
     }
 
-    /// @notice Override the updateTimelock function to prevent staking from being processed.
+    /// @notice Override the updateTimelock function to pause Governor interactions.
     function updateTimelock(TimelockControllerUpgradeable) public virtual override {
         revert("L2GovernorPaused: Governor is paused");
     }

diff --git a/src/L2/paused/L2VotingPowerPaused.sol b/src/L2/paused/L2VotingPowerPaused.sol
@@ -13,7 +13,7 @@ contract L2VotingPowerPaused is L2VotingPower {
         version = "1.0.0-paused";
     }
 
-    /// @notice Override the modifyLockingPosition function to prevent staking from being processed.
+    /// @notice Override the modifyLockingPosition function to pause VotingPower interactions.
     function adjustVotingPower(
         address,
         IL2LockingPosition.LockingPosition memory,
@@ -26,12 +26,12 @@ contract L2VotingPowerPaused is L2VotingPower {
         revert("L2VotingPowerPaused: VotingPower is paused");
     }
 
-    /// @notice Override the modifyLockingPosition function to prevent staking from being processed.
+    /// @notice Override the modifyLockingPosition function to pause VotingPower interactions.
     function delegate(address) public virtual override {
         revert("L2VotingPowerPaused: VotingPower is paused");
     }
 
-    /// @notice Override the modifyLockingPosition function to prevent staking from being processed.
+    /// @notice Override the modifyLockingPosition function to pause VotingPower interactions.
     function delegateBySig(address, uint256, uint256, uint8, bytes32, bytes32) public virtual override {
         revert("L2VotingPowerPaused: VotingPower is paused");
     }