privacy-scaling-explorations / halo2

https://privacy-scaling-explorations.github.io/halo2/
Other
201 stars 121 forks source link

doc: add comments to permutation prover structs #355

Open guorong009 opened 2 months ago

guorong009 commented 2 months ago

Description

Document the permutation prover types, in halo2_backend

Related issues

Resolve #264

Changes

guorong009 commented 2 months ago

@davidnevadoc Can you take a look at the PR? It's a tiny PR for documentation. So, I think we can merge this before new release.

guorong009 commented 2 months ago

Mark as draft until new release.

codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.64%. Comparing base (445d1da) to head (23ada39).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #355 +/- ## ======================================= Coverage 82.64% 82.64% ======================================= Files 84 84 Lines 17750 17750 ======================================= Hits 14670 14670 Misses 3080 3080 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.