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

Dao contracts documentation #274

Merged
merged 14 commits into from
Nov 30, 2022

Conversation

MiltonTulli
Copy link
Member

@MiltonTulli MiltonTulli commented Nov 25, 2022

Description

Improve DAOController, DAOAvatar, DAOReputation, DXDVotingMachine & Scheme contracts documentation.

Refactor comments, arguments, and returns definitions.

https://github.com/MiltonTulli/dxdao-contracts/blob/feaure/1.5-documentation/docs/SUMMARY.md

@MiltonTulli MiltonTulli requested a review from AugustoL November 25, 2022 20:36
@MiltonTulli MiltonTulli marked this pull request as draft November 26, 2022 17:40
@MiltonTulli MiltonTulli changed the title 1.5 documentation [wip] 1.5 documentation Nov 28, 2022
@MiltonTulli MiltonTulli force-pushed the feaure/1.5-documentation branch from a9b681d to c374593 Compare November 29, 2022 15:46
@AugustoL AugustoL changed the base branch from refactor-dxdao-contracts to v2.0 November 29, 2022 21:38
@MiltonTulli MiltonTulli marked this pull request as ready for review November 30, 2022 14:06
@MiltonTulli MiltonTulli changed the title [wip] 1.5 documentation Dao contracts documentation Nov 30, 2022
contracts/dao/votingMachine/DXDVotingMachine.sol Outdated Show resolved Hide resolved
contracts/dao/votingMachine/DXDVotingMachine.sol Outdated Show resolved Hide resolved
* @dev getProposalScheme return the schemeId for a given proposal
* @param _proposalId the ID of the proposal
* @return bytes32 scheme identifier
* @dev Return the schemeId for a given proposal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ReturnS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed all "return" typos. Than you

@MiltonTulli MiltonTulli requested a review from AugustoL November 30, 2022 15:14
@MiltonTulli MiltonTulli merged commit 111ae40 into DXgovernance:v2.0 Nov 30, 2022
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.

2 participants