L-02 Missing Docstrings #2319
Merged
L-02 Missing Docstrings #2319
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
sparrowDom
requested review from
DanielVF,
naddison36,
shahthepro and
clement-ux
as code owners
clement-ux
approved these changes
Dec 5, 2024
DanielVF
reviewed
Dec 5, 2024
contracts/contracts/token/OUSD.sol
Outdated
| @@ -40,23 +67,41 @@ contract OUSD is Governable { | |||
|
|
|||
| uint256[154] private _gap; // Slots to align with deployed contract | |||
| uint256 private constant MAX_SUPPLY = type(uint128).max; | |||
| /// @dev The value of tokens in existence | |||
There was a problem hiding this comment.
"value" implies worth. Perhaps, "amount".
There was a problem hiding this comment.
good point changed 👍
DanielVF
reviewed
Dec 5, 2024
DanielVF
reviewed
Dec 5, 2024
DanielVF
approved these changes
Dec 5, 2024
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.
Issue by Open Zeppelin team:
Within OUSD.sol, multiple instances of missing docstrings were identified:
The TotalSupplyUpdatedHighres event
The AccountRebasingEnabled event
The AccountRebasingDisabled event
The Transfer event
The Approval event
The YieldDelegated event
The YieldUndelegated event
The totalSupply state variable
The vaultAddress state variable
The rebaseState state variable
The yieldTo state variable
The yieldFrom state variable
The initialize function
The symbol function
The name function
The decimals function
Consider thoroughly documenting all functions (and their parameters) that are part of any contract's public API. Functions implementing sensitive functionality, even if not public, should be clearly documented as well. When writing docstrings, consider following the Ethereum Natural Specification Format (NatSpec).
Origin comment: All the missing natspec have been added