docs: polish NatSpec

test: polish tests
sablier-labs · Jun 20, 2024 · 102b49f · 102b49f
1 parent 71ccb90
commit 102b49f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/src/SablierV2MerkleLockupFactory.sol b/src/SablierV2MerkleLockupFactory.sol
@@ -29,7 +29,6 @@ contract SablierV2MerkleLockupFactory is ISablierV2MerkleLockupFactory {
     {
         uint64 totalPercentage;
         for (uint256 i = 0; i < tranches.length; ++i) {
-            // It would revert if the sum of percentages overflows.
             totalPercentage += tranches[i].unlockPercentage.unwrap();
         }
         return totalPercentage == uUNIT;

diff --git a/src/interfaces/ISablierV2MerkleLockupFactory.sol b/src/interfaces/ISablierV2MerkleLockupFactory.sol
@@ -41,9 +41,10 @@ interface ISablierV2MerkleLockupFactory {
                                  CONSTANT FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*/
 
-    /// @notice Verify the sum of percentages in `tranches` equals 100% , i.e. 1e18.
+    /// @notice Verifies if the sum of percentages in `tranches` equals 100% , i.e. 1e18.
     /// @dev Reverts if the sum of percentages overflows.
     /// @param tranches The tranches with their respective unlock percentages.
+    /// @return result True if the sum of percentages equals 100%, otherwise false.
     function isPercentagesSum100(MerkleLT.TrancheWithPercentage[] calldata tranches)
         external
         pure

diff --git a/test/integration/merkle-lockup/factory/is-percentages-sum-100/isPercentagesSum100.t.sol b/test/integration/merkle-lockup/factory/is-percentages-sum-100/isPercentagesSum100.t.sol
@@ -25,7 +25,7 @@ contract IsPercentagesSum100_Integration_Test is MerkleLockup_Integration_Test {
     }
 
     function test_TotalPercentageLessThanOneHundred()
-        public
+        external
         view
         whenSumDoesNotOverflow
         whenTotalPercentageNotOneHundred
@@ -38,7 +38,7 @@ contract IsPercentagesSum100_Integration_Test is MerkleLockup_Integration_Test {
     }
 
     function test_TotalPercentageGreaterThanOneHundred()
-        public
+        external
         view
         whenSumDoesNotOverflow
         whenTotalPercentageNotOneHundred
@@ -54,7 +54,7 @@ contract IsPercentagesSum100_Integration_Test is MerkleLockup_Integration_Test {
         _;
     }
 
-    function test_IsPercentagesSum100() public view whenSumDoesNotOverflow whenTotalPercentageOneHundred {
+    function test_IsPercentagesSum100() external view whenSumDoesNotOverflow whenTotalPercentageOneHundred {
         assertTrue(merkleLockupFactory.isPercentagesSum100(defaults.tranchesWithPercentages()), "isPercentagesSum100");
     }
 }
diff --git a/test/integration/merkle-lockup/factory/is-percentages-sum-100/isPercentagesSum100.tree b/test/integration/merkle-lockup/factory/is-percentages-sum-100/isPercentagesSum100.tree
@@ -1,11 +1,11 @@
 isPercentagesSum100.t.sol
 ├── when the sum of the percentages overflows
-│   └── it should revert
+│  └── it should revert
 └── when the sum of the percentages does not overflow
-    ├── when the sum of the percentages does not equal 100%
-    │   ├── when the sum of the percentages is less than 100%
-    │   │   └── it should return false
-    │   └── when the sum of the percentages is greater than 100%
-    │       └── it should return false
-    └── when the sum of the percentages equals 100%
-        └── it should return true
+   ├── when the sum of the percentages does not equal 100%
+   │  ├── when the sum of the percentages is less than 100%
+   │  │  └── it should return false
+   │  └── when the sum of the percentages is greater than 100%
+   │     └── it should return false
+   └── when the sum of the percentages equals 100%
+      └── it should return true