openzeppelin-contracts icon indicating copy to clipboard operation
openzeppelin-contracts copied to clipboard
verified publisher icon OpenZeppelin

Use @inheritdoc instead of See

Open GrandSchtroumpf opened this issue 3 years ago • 2 comments

Fixes #3502

Remove comments of type @dev See {CONTRACT-METHOD} that do not add more context. Solc will inherit the comment by default.

PR Checklist

  • [x] Tests
  • [ ] Documentation
  • [ ] Changelog entry

GrandSchtroumpf avatar Jun 24 '22 09:06 GrandSchtroumpf

Thank you @GrandSchtroumpf. I'm noticing that the API docs are no longer present in the deploy preview that was generated for this PR and I'm not sure what's causing it yet.

frangio avatar Jul 06 '22 00:07 frangio

Following up, I still don't understand why the API docs are no longer present so we can't merge this. I don't have a lot of time to look into this for the moment. Sorry! For the record, here are the build logs though I couldn't find anything to indicate the cause: https://app.netlify.com/sites/openzeppelin-contracts-docs/deploys/62cd77f4ab4af80009167c4b

frangio avatar Jul 12 '22 13:07 frangio