docs: minor improvement

MathisGD · web-flow · commit d21e94037472 · 2024-02-19T17:03:20.000+01:00
Signed-off-by: MathisGD &lt;74971347+MathisGD@users.noreply.github.com&gt;
diff --git a/src/wsteth-exchange-rate-adapter/WstEthEthExchangeRateChainlinkAdapter.sol b/src/wsteth-exchange-rate-adapter/WstEthEthExchangeRateChainlinkAdapter.sol
@@ -23,6 +23,7 @@ contract WstEthEthExchangeRateChainlinkAdapter is MinimalAggregatorV3Interface {
         WST_ETH = IWstEth(wstEth);
     }
 
+    /// @dev Silently overflows if `stEthPerToken` is greater than `type(int256).max`.
     function latestRoundData() external view returns (uint80, int256, uint256, uint256, uint80) {
         // It is assumed that `stEthPerToken` returns a price with 18 decimals precision.
         return (0, int256(WST_ETH.stEthPerToken()), 0, 0, 0);

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ contract WstEthEthExchangeRateChainlinkAdapter is MinimalAggregatorV3Interface {`
`23`	`23`	`WST_ETH = IWstEth(wstEth);`
`24`	`24`	`}`
`25`	`25`
	`26`	+ /// @dev Silently overflows if `stEthPerToken` is greater than `type(int256).max`.
`26`	`27`	`function latestRoundData() external view returns (uint80, int256, uint256, uint256, uint80) {`
`27`	`28`	// It is assumed that `stEthPerToken` returns a price with 18 decimals precision.
`28`	`29`	`return (0, int256(WST_ETH.stEthPerToken()), 0, 0, 0);`