farcasterxyz / contracts

Implementation of the Farcaster contracts
https://www.farcaster.xyz/
MIT License
340 stars 122 forks source link

chore: use inheritdoc tag #384

Closed horsefacts closed 1 year ago

horsefacts commented 1 year ago

Motivation

Reduce duplication in natspec comments by using the @inheritdoc tag.

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

Additional Context

This PR includes an unrelated fix to a fuzz test missing a vm.assume.


PR-Codex overview

Detailed summary

The following files were skipped due to too many changes: src/IdRegistry.sol, src/StorageRegistry.sol

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

github-actions[bot] commented 1 year ago

Coverage after merging horsefacts/inheritdoc into main will be

98.65%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
src
   Bundler.sol100%100%100%100%
   FnameResolver.sol100%100%100%100%
   IdRegistry.sol100%100%100%100%
   KeyRegistry.sol100%100%100%100%
   RecoveryProxy.sol100%100%100%100%
   StorageRegistry.sol100%100%100%100%
src/lib
   EIP712.sol50%100%50%50%19
   Signatures.sol100%100%100%100%
   TransferHelper.sol0%0%0%0%12, 17, 20, 20, 20
   TrustedCaller.sol100%100%100%100%
src/validators
   SignedKeyRequestValidator.sol100%100%100%100%