Closed Ginowine closed 4 weeks ago
@Ginowine LGTM! except for this small comment: NatSpec tags are all optional. That is, if
@notice
explains what the function does, there is no need to add a@dev
. only add it when there are extra details Can you please give it another small iteration, where if a@notice
suffices just remove@dev
Thanks
@salaheldinsoliman. Ok great, thanks. I'll go through it again.
could you rename the PR to follow the guidelines on confluence?
Description of change
Some of the magic contract reference docs are missing information about using the functions. This PR adds Solidity docstrings to the functions of the following contracts:
Links to any relevant issues
`fixes issue #3422
Type of change
Change checklist
Tick the boxes that are relevant to your changes, and delete any items that are not.
develop
branch as the target branch