From 16d77f37ee2bda6434a4a7f6d8c8488b20e539dd Mon Sep 17 00:00:00 2001 From: "A.L." Date: Fri, 14 Jun 2024 23:01:52 +0200 Subject: [PATCH] docs: fix comment for `rewardGasAmount` --- src/ReservoirPriceOracle.sol | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/ReservoirPriceOracle.sol b/src/ReservoirPriceOracle.sol index 3a45fb9..df29180 100644 --- a/src/ReservoirPriceOracle.sol +++ b/src/ReservoirPriceOracle.sol @@ -57,10 +57,7 @@ contract ReservoirPriceOracle is IPriceOracle, IReservoirPriceOracle, Owned(msg. /// 1e18 == 100% uint64 public priceDeviationThreshold; - // TODO: Wording is confusing. Say "This number is multiplied by the base - // fee to determine the reward for keepers". - /// @notice multiples of the base fee the contract rewards the caller for updating the price when it goes - /// beyond the `priceDeviationThreshold` + /// @notice This number is multiplied by the base fee to determine the reward for keepers uint64 public rewardGasAmount; /// @notice TWAP period (in seconds) for querying the oracle