vacp2p / rln-contract

RLN contract
Apache License 2.0
13 stars 6 forks source link

docs: natspec comments + docgen #18

Closed rymnc closed 1 year ago

rymnc commented 1 year ago

Uses solidity-docgen to generate docs in the pre-commit hook

github-actions[bot] commented 1 year ago

LCOV of commit 71ba533 during CI #10

Summary coverage rate:
  lines......: 100.0% (492 of 492 lines)
  functions..: 100.0% (9 of 9 functions)
  branches...: 100.0% (24 of 24 branches)

Files changed coverage rate:
                              |Lines       |Functions  |Branches    
  Filename                    |Rate     Num|Rate    Num|Rate     Num
  ==================================================================
  contracts/PoseidonHasher.sol| 100%    461| 100%     2|    -      0
  contracts/Rln.sol           | 100%     31| 100%     7| 100%     24