Skip to content

Commit

Permalink
docs: replace natspec comment with normal comment
Browse files Browse the repository at this point in the history
  • Loading branch information
xenide committed Jun 14, 2024
1 parent ea4e7e3 commit b63411b
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions src/ReservoirPriceOracle.sol
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,7 @@ contract ReservoirPriceOracle is IPriceOracle, IReservoirPriceOracle, Owned(msg.
/// @dev If `address(0)` then there is no fallback.
address public fallbackOracle;

// TODO: Natspec must be tied to a member. In this case this comment is tied
// to priceDeviationThreshold. Is that correct? Maybe just do a normal (//)
// comment?
/// @dev the following 4 storage variables take up 1 storage slot
// The following 4 storage variables take up 1 storage slot.

/// @notice percentage change greater than which, a price update may result in a reward payout of native tokens,
/// subject to availability of rewards.
Expand Down

0 comments on commit b63411b

Please sign in to comment.