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 and generate code documentation #22

Closed
ZER0 opened this issue Sep 27, 2019 · 1 comment · Fixed by #32
Closed

Add and generate code documentation #22

ZER0 opened this issue Sep 27, 2019 · 1 comment · Fixed by #32
Assignees
@CPerezz

Comments

@ZER0
Copy link
Contributor

ZER0 commented Sep 27, 2019

The code is almost undocumented, we should start to add the docs.
@CPerezz CPerezz self-assigned this Oct 3, 2019
@CPerezz
Copy link
Contributor

CPerezz commented Oct 3, 2019

Should gadgets.rs be documented? Since they are only used to test the blindbid protocol, and as discussed with @ZER0 and @vlopes11, these tests should be moved to the dusk-network/blindbid library and removed from this crate.

So I don't know if it's worth it to comment the gadgets.rs file.

CPerezz added a commit that referenced this issue Oct 3, 2019
@CPerezz
Add docs for scalar, mds_matrix, round_constants and errors
790fd75 
This tries to half-close #22
@CPerezz CPerezz mentioned this issue Oct 3, 2019
Merged
ZER0 pushed a commit that referenced this issue May 7, 2020
@CPerezz
Add docs for scalar, mds_matrix, round_constants and errors
5265e5b 
This tries to half-close #22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CPerezz CPerezz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[WIP] Add doc comments for the code. dusk-network/Hades252
2 participants
@ZER0 @CPerezz