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 some more explicit doc on plonky2 crate main components #1447

Merged
merged 8 commits into from
Jan 11, 2024
Merged

Add some more explicit doc on plonky2 crate main components #1447

merged 8 commits into from
Jan 11, 2024

Conversation

Nashtare
Copy link
Collaborator

@Nashtare Nashtare commented Jan 8, 2024

Tackles part of the comments in #1446 (not fully, but that's at least a start which I hope can help the understanding of newcomers).

@Nashtare Nashtare self-assigned this Jan 8, 2024
@Nashtare Nashtare added the documentation Improvements or additions to documentation label Jan 8, 2024
Gorzorg
Gorzorg approved these changes Jan 11, 2024
View reviewed changes
Copy link

@Gorzorg Gorzorg left a comment

Choose a reason for hiding this comment

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

Thank you! This is already very helpful.

LindaGuiga
LindaGuiga approved these changes Jan 11, 2024
View reviewed changes
Copy link
Contributor

@LindaGuiga LindaGuiga left a comment

Choose a reason for hiding this comment

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

A few nitpicks, but looks good to me!

plonky2/src/gates/gate.rs Show resolved Hide resolved
plonky2/src/gates/gate.rs Outdated Show resolved Hide resolved
plonky2/src/gates/mod.rs Outdated Show resolved Hide resolved
plonky2/src/gates/gate.rs Outdated Show resolved Hide resolved
plonky2/src/gates/multiplication_extension.rs Outdated Show resolved Hide resolved
plonky2/src/plonk/circuit_builder.rs Outdated Show resolved Hide resolved
plonky2/src/plonk/circuit_builder.rs Outdated Show resolved Hide resolved
plonky2/src/plonk/circuit_builder.rs Outdated Show resolved Hide resolved
plonky2/src/plonk/config.rs Show resolved Hide resolved
plonky2/src/plonk/circuit_data.rs Show resolved Hide resolved
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jan 11, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@Nashtare Nashtare merged commit 3b1ed82 into 0xPolygonZero:main Jan 11, 2024
4 checks passed
@Nashtare Nashtare deleted the plonky2_doc branch January 11, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LindaGuiga LindaGuiga LindaGuiga approved these changes

@Gorzorg Gorzorg Gorzorg approved these changes

Assignees

@Nashtare Nashtare

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Nashtare @Gorzorg @LindaGuiga