Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Docstrings/Comments on Contract Code #34

Open
villanuevawill opened this issue Mar 26, 2018 · 1 comment
Open

Better Docstrings/Comments on Contract Code #34

villanuevawill opened this issue Mar 26, 2018 · 1 comment

Comments

@villanuevawill
Copy link

As this code is likely to be audited by others more closely, I think it would be great to start building clear comments and docstrings. I really like the format here: https://github.com/ConsenSys/PLCRVoting/blob/master/contracts/PLCRVoting.sol#L78

I like how it's clearly split into its helpers, etc.. In this case, it could be split into bounty interfaces, fulfillment interfaces, and helpers/internal. It is very clean, makes for more readable content, and gives more trust to the standard.

@villanuevawill
Copy link
Author

villanuevawill commented Mar 26, 2018

Also - have a line explaining it is a duplication check, explaining it is verifying no overflow, or explaining it is verifying we don't go over array max size.

@mbeylin mbeylin mentioned this issue Apr 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant