docs: nitpicks

sablier-labs · Jan 10, 2025 · 428d633 · 428d633
1 parent 6612610
commit 428d633
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/src/libraries/Errors.sol b/src/libraries/Errors.sol
@@ -107,7 +107,8 @@ library Errors {
     /// @notice Thrown when trying to create a tranched stream with unordered tranche timestamps.
     error SablierHelpers_TrancheTimestampsNotOrdered(uint256 index, uint40 previousTimestamp, uint40 currentTimestamp);
 
-    /// @notice Thrown when trying to create a stream with the sum of the unlock amounts greater than deposit amount.
+    /// @notice Thrown when trying to create a stream with the sum of the unlock amounts greater than the deposit
+    /// amount.
     error SablierHelpers_UnlockAmountsSumTooHigh(
         uint128 depositAmount, uint128 startUnlockAmount, uint128 cliffUnlockAmount
     );

diff --git a/src/libraries/Helpers.sol b/src/libraries/Helpers.sol
@@ -223,7 +223,7 @@ library Helpers {
             revert Errors.SablierHelpers_StartTimeNotLessThanEndTime(timestamps.start, timestamps.end);
         }
 
-        // Check: the sum of the start and cliff unlock amounts is not greater than deposit amount.
+        // Check: the sum of the start and cliff unlock amounts is not greater than the deposit amount.
         if (unlockAmounts.start + unlockAmounts.cliff > depositAmount) {
             revert Errors.SablierHelpers_UnlockAmountsSumTooHigh(
                 depositAmount, unlockAmounts.start, unlockAmounts.cliff

diff --git a/src/libraries/VestingMath.sol b/src/libraries/VestingMath.sol
@@ -129,8 +129,8 @@ library VestingMath {
     /// - $c$ is the cliff unlock amount.
     ///
     /// Assumptions:
-    /// 1. The sum of the unlock amounts (start and cliff) does not overflow uint128 and is less than or equal to
-    /// deposit amount.
+    /// 1. The sum of the unlock amounts (start and cliff) does not overflow uint128, and is less than or equal to
+    /// the deposit amount.
     /// 2. The start time is before the end time.
     /// 3. If the cliff time is not zero, it is after the start time and before the end time.
     function calculateLockupLinearStreamedAmount(
@@ -212,8 +212,8 @@ library VestingMath {
     /// - $\Sigma(eta)$ is the sum of all vested tranches' amounts.
     ///
     /// Assumptions:
-    /// 1. The sum of all tranche amounts does not overflow uint128 and equals the deposited amount.
-    /// 2. The first tranche's timestamp is greater than the start time and the last tranche's timestamp
+    /// 1. The sum of all tranche amounts does not overflow uint128, and equals the deposited amount.
+    /// 2. The first tranche's timestamp is greater than the start time, and the last tranche's timestamp
     /// equals the end time.
     /// 3. The tranche timestamps are arranged in ascending order.
     function calculateLockupTranchedStreamedAmount(