DualGovernance and Timelock section comments

F-WRunTime · Sep 25, 2024 · 2b9b021 · 2b9b021
1 parent 0c8f50e
commit 2b9b021
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/contracts/DualGovernance.sol b/contracts/DualGovernance.sol
@@ -54,7 +54,7 @@ contract DualGovernance is IDualGovernance {
     event ResealCommitteeSet(address resealCommittee);
 
     // ---
-    // Sanity Check Parameters
+    // Sanity Check Parameters & Immutables
     // ---
 
     /// @notice The parameters for the sanity checks.
@@ -138,6 +138,10 @@ contract DualGovernance is IDualGovernance {
     ///     period of time when the Dual Governance proposal adoption is blocked.
     address internal _resealCommittee;
 
+    // ---
+    // Constructor
+    // ---
+
     constructor(ExternalDependencies memory dependencies, SanityCheckParams memory sanityCheckParams) {
         TIMELOCK = dependencies.timelock;
         RESEAL_MANAGER = dependencies.resealManager;
@@ -471,11 +475,11 @@ contract DualGovernance is IDualGovernance {
     }
 
     // ---
-    // Reseal executor
+    // Sealables Resealing
     // ---
 
     /// @notice Allows the reseal committee to "reseal" (pause indefinitely) an instance of a sealable contract through
-    ///         the ResealManager contract.
+    ///     the ResealManager contract.
     /// @param sealable The address of the sealable contract to be resealed.
     function resealSealable(address sealable) external {
         _stateMachine.activateNextState(ESCROW_MASTER_COPY);
@@ -498,7 +502,7 @@ contract DualGovernance is IDualGovernance {
     }
 
     // ---
-    // Private methods
+    // Internal methods
     // ---
 
     function _checkCallerIsAdminExecutor() internal view {

diff --git a/contracts/EmergencyProtectedTimelock.sol b/contracts/EmergencyProtectedTimelock.sol
@@ -355,7 +355,7 @@ contract EmergencyProtectedTimelock is IEmergencyProtectedTimelock {
     }
 
     // ---
-    // Private Methods
+    // Internal Methods
     // ---
 
     function _checkCallerIsAdminExecutor() internal view {
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         // ---
-        // Private Methods
+        // Internal Methods
         // ---
         function _checkCallerIsAdminExecutor() internal view {
@@ Expand Down @@