Fix Proposals NatSpecs (#11257)

celo-org · Oct 16, 2024 · 79cccad · 79cccad
1 parent 451def4
commit 79cccad
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/protocol/contracts/governance/Proposals.sol b/packages/protocol/contracts/governance/Proposals.sol
@@ -169,6 +169,10 @@ library Proposals {
     executeTransactions(proposal.transactions);
   }
 
+  /**
+   * @notice Executes a list of transactions.
+   * @param transactions The transactions to execute.
+   */
   function executeTransactions(Transaction[] memory transactions) internal {
     for (uint256 i = 0; i < transactions.length; i = i.add(1)) {
       require(
@@ -219,6 +223,7 @@ library Proposals {
    * @param dataLengths The lengths of each transaction's data.
    * @param proposer The proposer.
    * @param deposit The proposal deposit.
+   * @return The constructed proposal struct.
    */
   function makeMem(
     uint256[] memory values,
@@ -275,6 +280,7 @@ library Proposals {
    * @return transaction Transaction count.
    * @return description Description url.
    * @return networkWeight Network weight.
+   * @return Approval status.
    */
   function unpack(
     Proposal storage proposal