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.

Sign up for GitHub

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

Jump to bottom

Add a proper documentation to the contracts #32

Merged
merged 3 commits into from
Jan 30, 2025
Merged

Add a proper documentation to the contracts #32

merged 3 commits into from
Jan 30, 2025

Conversation

cabrador
Copy link
Contributor

This PR adds a proper documentation to the contracts

@cabrador cabrador force-pushed the c/document-contracts branch from 28f5216 to 0741963 Compare January 23, 2025 09:38
@cabrador cabrador requested review from thaarok and jmpike January 23, 2025 09:38
This was referenced Jan 27, 2025
Open
Draft
thaarok
thaarok reviewed Jan 27, 2025
View reviewed changes
Copy link
Collaborator

@thaarok thaarok left a comment

Choose a reason for hiding this comment

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

I am not sure if we should not simplify it first, reduce the unnecessary code and add documentation after...

contracts/adapters/RelayProxy.sol Outdated Show resolved Hide resolved
contracts/adapters/SFCToGovernable.sol Outdated Show resolved Hide resolved
contracts/adapters/SFCToGovernable.sol Show resolved Hide resolved
contracts/governance/Constants.sol Outdated Show resolved Hide resolved
@cabrador cabrador requested a review from thaarok January 28, 2025 10:32
@cabrador cabrador mentioned this pull request Jan 28, 2025
Draft
@cabrador cabrador force-pushed the c/document-contracts branch 2 times, most recently from aac7014 to 15c67ac Compare January 30, 2025 09:39
@cabrador cabrador force-pushed the c/document-contracts branch from 50137a3 to c6d6d67 Compare January 30, 2025 09:57
@cabrador cabrador merged commit a0b307e into master Jan 30, 2025
@cabrador cabrador deleted the c/document-contracts branch January 30, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thaarok thaarok thaarok approved these changes

@jmpike jmpike Awaiting requested review from jmpike

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cabrador @thaarok