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

merge branch_v.1.1.2r #24

Closed
wants to merge 15 commits into from
Closed

merge branch_v.1.1.2r #24

wants to merge 15 commits into from

Conversation

zfliex924
Copy link
Collaborator

No description provided.

…of major functions (#26)

Contract documentation: providing a detailed non-developer description of major functions #26

- This PR aims to increase the visibility of the DAO's non-developers into the smart contract. Such visibility is crucial for aligning the entire org into a single, clear, world-image of what the contracts are actually doing. It should also have a major effect on the depth and quality of our auditing process (both internal and external).

- Most of the work here involved adding function header comments, in some cases I've also added modifiers where I thought they would result in clearer function signatures.

- In creating the internal docs I did my best to catch the key functions and to describe what the code does rather than what it is, Of course, this is the start of this effort and we will probably need several review/improvement cycles before the internal docs will have the impact I believe it could have on the org-wise clarity of how the contracts actually behave.

- I have used @Product and @logic tags to denote, respectively, high-level comments aimed (also) to the DAO's PMs and the function's flow, or logic, descriptor. Feel free to suggest better taggings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants