From d33ba9c90bd154d7f48eea5b01088b93d8b34b40 Mon Sep 17 00:00:00 2001 From: Alberto Date: Thu, 13 Jun 2024 16:34:20 +0200 Subject: [PATCH] docs: correcting natspec from tricrypto-ng --- contracts/main/CurveTwocrypto.vy | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/contracts/main/CurveTwocrypto.vy b/contracts/main/CurveTwocrypto.vy index 9cc1e09..ca52219 100644 --- a/contracts/main/CurveTwocrypto.vy +++ b/contracts/main/CurveTwocrypto.vy @@ -1443,13 +1443,12 @@ def burnFrom(_to: address, _value: uint256) -> bool: @view def internal_price_oracle() -> uint256: """ - @notice Returns the oracle price of the coin at index `k` w.r.t the coin + @notice Returns the oracle price of the coin at index 1 w.r.t the coin at index 0. @dev The oracle is an exponential moving average, with a periodicity determined by `self.ma_time`. The aggregated prices are cached state prices (dy/dx) calculated AFTER the latest trade. - @param k The index of the coin. - @return uint256 Price oracle value of kth coin. + @return uint256 Price oracle value of second coin. """ price_oracle: uint256 = self.cached_price_oracle price_scale: uint256 = self.cached_price_scale