Add missing docstrings #5168
Add missing docstrings #5168
Conversation
|
| /** | ||
| * @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call | ||
| * encoded in `data`. | ||
| * | ||
| * See {{UUPSUpgradeable-upgradeToAndCall}} | ||
| */ |
There was a problem hiding this comment.
I'd reconsider adding this. The interface is not available in the documentation and we kept it here since we didn't want it to be extensively documented. The upgradeToAndCall is already documented in the ERC1967Utils and I'm not sure how to make this available in the docs
There was a problem hiding this comment.
Not a big deal, I'm leaving it open and merging
There was a problem hiding this comment.
I tend to agree. Should we remove that natspec comment and replace it with a non natspec that says "see UUPSUpgradeable" ?
There was a problem hiding this comment.
And leave it with triple dashes e.g. ///? I'd agree.
There was a problem hiding this comment.
it would be double dash (not natspec)
Co-authored-by: Ernesto García <ernestognw@gmail.com>
Co-authored-by: Ernesto García <ernestognw@gmail.com> Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Fixes L-02
Fixes L-05
PR Checklist
npx changeset add)