NATSPEC comments - Githubissues

livepeer / protocol

Livepeer protocol

MIT License

154 stars 45 forks source link

NATSPEC comments #353

Closed kyriediculous closed 4 years ago

kyriediculous commented 4 years ago

This PR adds proper NATSPEC comment formatting to all contracts.

Changed some minor semantic details in BondingManager.js
Changed most @dev tags to @notice to distinguish end-user description from extra developer comments

Fixes #130

coveralls commented 4 years ago

Pull Request Test Coverage Report for Build 1211

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 1205:	0.0%
Covered Lines:	686
Relevant Lines:	686

💛 - Coveralls

kyriediculous commented 4 years ago

Tried to extend the consistency of @notice and @dev for external/internal functions respectively throughout all contracts, even those that weren't touched in the streamflow update 8d0bb3e.

We have a conflict in Minter.sol because I guess this branch was branched off of streamflow before the PR that reverted the minter changes was merged.

kyriediculous commented 4 years ago

Rebased !