docs: add @dev note about _allocateLQTY()

liquity · Dec 27, 2024 · 7cf3b1f · 7cf3b1f
1 parent 1df8113
commit 7cf3b1f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/Governance.sol b/src/Governance.sol
@@ -678,8 +678,9 @@ contract Governance is MultiDelegateCall, UserProxyFactory, ReentrancyGuard, Own
     }
 
     /// @dev For each given initiative applies relative changes to the allocation
-    /// NOTE: Given the current usage the function either: Resets the value to 0, or sets the value to a new value
-    ///     Review the flows as the function could be used in many ways, but it ends up being used in just those 2 ways
+    /// @dev Assumes that all the input arrays are of equal length
+    /// @dev NOTE: Given the current usage the function either: Resets the value to 0, or sets the value to a new value
+    ///      Review the flows as the function could be used in many ways, but it ends up being used in just those 2 ways
     function _allocateLQTY(
         address[] memory _initiatives,
         int256[] memory _deltaLQTYVotes,