refactor(contracts): add natspec across contracts and cleanup #898
Conversation
✅ Deploy Preview for maci-typedoc ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ctrlc03
force-pushed
the
chore/natspec
branch
from
69f1757 to
09e2f4e
Compare
| /// @notice This contracts contains a number of structures | ||
| /// which are to be passed as parameters to Poll contracts. | ||
| /// This way we can reduce the number of parameters | ||
| /// and avoid a stack too deep error during compilation. |
There was a problem hiding this comment.
I don't understand this sentence.
There was a problem hiding this comment.
Basically in the EVM there's a limit to how many local variables you can have (params and return values included) - so basically instead of passing 4 params for tree depths (as an example), we pass only one (the struct) - hope this makes sense
There was a problem hiding this comment.
It's clearer when you explain it :)
then maybe it should be avoid a stack of deep errors during compilation?
There was a problem hiding this comment.
"stack too deep" is the actual error name, you can read more here btw
ctrlc03
force-pushed
the
chore/natspec
branch
from
09e2f4e to
0c14c86
Compare
|
@kittybest thank you for the thorough review, I made some (a lot) changes, could you please take a look again? |
ctrlc03
force-pushed
the
chore/natspec
branch
3 times, most recently
from
3398bed to
c2f612c
Compare
ctrlc03
force-pushed
the
chore/natspec
branch
from
c2f612c to
a6ad25e
Compare
Currently, the smart contracts have incorrect and incomplete NatSpec comments. This PR adds NatSpec comments to ensure that automated documentation can be generated, and that developers have a better experience when working on the smart contracts. Furthemore, file structure has been re-organized for better accessibility
re #843