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

Adding doc comments to risc0_zkp crate, mostly in core. #254

Merged
merged 31 commits into from Aug 25, 2022
Merged

Adding doc comments to risc0_zkp crate, mostly in core. #254

merged 31 commits into from Aug 25, 2022

Conversation

3lkn
Copy link
Contributor

@3lkn 3lkn commented Aug 25, 2022

No description provided.

3lkn and others added 29 commits August 22, 2022 10:54
@3lkn
including Goldilocks
45059b0
@3lkn
Adding Goldilocks field
cf3cac4
@3lkn
Merge branch 'main' into elakn/fields
44623f3
@3lkn
Merge branch 'main' of https://github.com/risc0/risc0 into elakn/fields
bda8f55
@3lkn
simplifying test for native operations
9f7ca78
@3lkn
Merge branch 'elakn/fields' of https://github.com/risc0/risc0 into el…
1d548e9 
…akn/fields
@3lkn @flaub
Update risc0/zkp/rust/src/field/goldilocks.rs
3f3e938 
Co-authored-by: Frank Laub <flaub@risc0.com>
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/goldilocks.rs
bb7aeba 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/goldilocks.rs
33af69b 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn
updated Goldilocks with suggested changes
2cd8ce5
@3lkn
updating comments in and
54af67f
@3lkn @flaub
Update risc0/zkp/rust/src/field/goldilocks.rs
1d3101f 
Co-authored-by: Frank Laub <flaub@risc0.com>
@3lkn @flaub
Update risc0/zkp/rust/src/field/goldilocks.rs
015a03b 
Co-authored-by: Frank Laub <flaub@risc0.com>
@3lkn
adding comment to explain Goldilocks field calculation
1e68c23
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/baby_bear.rs
a1a2c9f 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/goldilocks.rs
665ae15 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/goldilocks.rs
08c6e7b 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn @flaub
Update risc0/zkp/rust/src/field/goldilocks.rs
ca56c8e 
Co-authored-by: Frank Laub <flaub@risc0.com>
@3lkn @flaub
Update risc0/zkp/rust/src/field/goldilocks.rs
510b785 
Co-authored-by: Frank Laub <flaub@risc0.com>
@3lkn
minor comment edits to field/mod.rs
4428c73
@3lkn @tzerrell
Update risc0/zkp/rust/src/field/goldilocks.rs
6160b53 
Co-authored-by: Tim Zerrell <tim.zerrell@risczero.com>
@3lkn
documentation for fields
2c94984
@3lkn
adding descriptions for Elem, ExtElem, and RootsOfUnity
f081770
@3lkn
Merge branch 'main' of https://github.com/risc0/risc0 into elakn/fields
0a93d83
@3lkn
giving tests more descriptive names
c0e362f
@3lkn
Merge branch 'main' of https://github.com/risc0/risc0 into elakn/prov…
de82593 
…er_docs
@3lkn
fixing conflicting changes to field/mod.rs
f9a1aea
@3lkn
updating docs and comments for zkp core
8652223
@3lkn
Merge branch 'main' of https://github.com/risc0/risc0 into elakn/core…
5770b5f 
…_docs
@3lkn 3lkn requested a review from flaub August 25, 2022 01:34
@3lkn 3lkn requested review from shkoo and tzerrell August 25, 2022 01:34
tzerrell
tzerrell reviewed Aug 25, 2022
View reviewed changes
Copy link
Member

@tzerrell tzerrell left a comment

Choose a reason for hiding this comment

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

Great! Two inline details

risc0/zkp/rust/src/core/mod.rs Outdated Show resolved Hide resolved
risc0/zkp/rust/src/core/mod.rs Outdated Show resolved Hide resolved
@3lkn 3lkn merged commit d52308b into main Aug 25, 2022
@3lkn 3lkn deleted the elakn/core_docs branch August 25, 2022 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tzerrell tzerrell tzerrell left review comments

@flaub flaub flaub approved these changes

@shkoo shkoo Awaiting requested review from shkoo

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

Successfully merging this pull request may close these issues.

None yet
3 participants
@3lkn @flaub @tzerrell