Improve doc for Timelock cancel function

OpenZeppelin · Dec 16, 2024 · 3d22a75 · 3d22a75
1 parent c1715c7
commit 3d22a75
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/modules/ROOT/pages/api/governance.adoc b/docs/modules/ROOT/pages/api/governance.adoc
@@ -2911,12 +2911,12 @@ Emits {ITimelock-CallSalt} event if `salt` is not zero.
 [[ITimelock-cancel]]
 ==== `[.contract-item-name]#++cancel++#++(id: felt252)++` [.item-kind]#external#
 
-Cancel an operation.
+Cancels an operation. A canceled operation returns to `Unset` OperationState.
 
 Requirements:
 
 - The caller must have the `CANCELLER_ROLE` role.
-- `id` must be an operation.
+- `id` must be a pending operation.
 
 Emits a {ITimelock-CallCancelled} event.
 
@@ -3203,12 +3203,12 @@ Emits {TimelockComponent-CallSalt} event if `salt` is not zero.
 [[TimelockControllerComponent-cancel]]
 ==== `[.contract-item-name]#++cancel++#++(ref self: ContractState, id: felt252)++` [.item-kind]#external#
 
-Cancel an operation.
+Cancels an operation. A canceled operation returns to `Unset` OperationState.
 
 Requirements:
 
 - The caller must have the `CANCELLER_ROLE` role.
-- `id` must be an operation.
+- `id` must be a pending operation.
 
 Emits a {TimelockComponent-CallCancelled} event.
 

diff --git a/packages/governance/src/timelock/timelock_controller.cairo b/packages/governance/src/timelock/timelock_controller.cairo
@@ -267,7 +267,7 @@ pub mod TimelockControllerComponent {
             }
         }
 
-        /// Cancels an operation.
+        /// Cancels an operation. A canceled operation returns to `Unset` OperationState.
         ///
         /// Requirements:
         ///
-Original file line number
+Diff line change
@@ Expand Up / @@ -267,7 +267,7 @@ pub mod TimelockControllerComponent { @@
                 }
             }
-            /// Cancels an operation.
+            /// Cancels an operation. A canceled operation returns to `Unset` OperationState.
             ///
             /// Requirements:
             ///
@@ Expand Down @@