natspec(TabLib): Improved Documentation for _calculateTab #168
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asselstine
reviewed
Oct 5, 2021
contracts/libraries/TwabLib.sol
Outdated
| @@ -247,8 +247,20 @@ library TwabLib { | |||
| return differenceInAmount / differenceInTime; | |||
| } | |||
|
|
|||
| /// @notice Calculates the TWAB for a given timestamp. It interpolates as necessary. | |||
| /// @param _twabs The TWAB history | |||
| /** @notice Calculates a user TWAB for a target timestamp using the historical TWAB list. | |||
There was a problem hiding this comment.
I would add that it linearly interpolates a twab using the TWAB history.
asselstine
approved these changes
Oct 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.