natspec(Ticket): docs for _decreaseUserTwab

pooltogether · Oct 5, 2021 · 01f2d01 · 01f2d01
1 parent 922e16a
commit 01f2d01
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/contracts/Ticket.sol b/contracts/Ticket.sol
@@ -414,10 +414,9 @@ contract Ticket is ControlledToken, ITicket {
 
     /**
       * @notice Creates the next TWAB for a user with a decrementing balance.
-      * @dev    READS the user/delegate TWAB history and decrement their balance.
-                Lowering the average time-weighted balance, and updating user TWAB new
-                hisotry and emitting an event with an indexed holder and user/delegate 
-                address(s) with the updated TWAB.
+      * @dev    READS the user/delegate TWAB history and decrements user weighted balance.
+                After decreasing balance, updates the users new TWAB hisotry, and emits
+                an event with indexed holder and user/delegate address(s), plus the new TWAB.
       * @ @param _holder Token holder (i.e. msg.sender)
       * @ @param _user   Delegated address for TWAB lookup (default msg.sender)
       * @ @param _amount Amount transfered out of the account