search

decentdao / decent-contracts

Govern at startup speed
https://app.decentdao.org
MIT License
3 stars 3 forks source link

IAzorius documentation #35

Closed herbig closed 1 year ago

herbig commented 1 year ago

Description

Fleshing out documentation for the IAzorius interface.

herbig commented 1 year ago

Looks good! Main thing I'm worried about is removing the natspec from the Azorius contract. Why would we not just want to include the documentation in both the contract and the interface?

@tbwebb22 having the same comments repeated in two locations makes it likely they'll get out of sync, or at the least require updating two places at once to change, rather than having the implementation just say go look at the interface

tbwebb22 commented 1 year ago

Ok, I'm cool with this. I dug into it a bit more, didn't know that the Natspec was also inherited from base functions: https://docs.soliditylang.org/en/v0.8.17/natspec-format.html#inheritance-notes

Also didn't know about that @inheritdoc tag which is good to know

herbig commented 1 year ago

Ok, I'm cool with this. I dug into it a bit more, didn't know that the Natspec was also inherited from base functions: https://docs.soliditylang.org/en/v0.8.17/natspec-format.html#inheritance-notes

Also didn't know about that @inheritdoc tag which is good to know

oh cool yeah that's good to know, I should remove all the docs on the Azorius contract that are implementations of the interface, or add that tag