From 01f2d019a23ed4ebce9cf0564e74ec4c5f639495 Mon Sep 17 00:00:00 2001 From: kamescg Date: Tue, 5 Oct 2021 07:53:07 -0400 Subject: [PATCH] natspec(Ticket): docs for _decreaseUserTwab --- contracts/Ticket.sol | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/contracts/Ticket.sol b/contracts/Ticket.sol index 57b60ada..60a8fe6b 100644 --- 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