zec
/
halo2
mirror of https://github.com/zcash/halo2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix formatting of `halo2_proofs::multicore` comments 

Co-authored-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
str4d 2023-02-10 20:39:29 +00:00 committed by Jack Grigg
parent 36055ab47d
commit b90522797e
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -14,8 +14,8 @@ minor version bump.
`halo2` currently uses [rayon](https://github.com/rayon-rs/rayon) for parallel computation.
The `RAYON_NUM_THREADS` environment variable can be used to set the number of threads.
You can disable [rayon] by disabling the ["multicore"] feature.
Warning! Halo2 will lose access to parallelism if you disable the ["multicore"] feature.
You can disable `rayon` by disabling the `"multicore"` feature.
Warning! Halo2 will lose access to parallelism if you disable the `"multicore"` feature.
This will significantly degrade performance.
## License

4
halo2_proofs/README.md
View File

@ -15,8 +15,8 @@ minor version bump.
computation. The `RAYON_NUM_THREADS` environment variable can be used to set the number of
threads.
You can disable [rayon] by disabling the ["multicore"] feature.
Warning! Halo2 will lose access to parallelism if you disable the ["multicore"] feature.
You can disable `rayon` by disabling the `"multicore"` feature.
Warning! Halo2 will lose access to parallelism if you disable the `"multicore"` feature.
This will significantly degrade performance.
## License

6
halo2_proofs/src/multicore.rs
View File

@ -22,9 +22,9 @@ pub trait TryFoldAndReduce<T, E> {
/// Implements `iter.try_fold().try_reduce()` for `rayon::iter::ParallelIterator`,
/// falling back on `Iterator::try_fold` when the `multicore` feature flag is
/// disabled.
/// try_fold_and_reduce function can only be called by a iter with
/// Result<T,E> item type because the folder_op Fn<T,T>->T must
/// meet both trait bound of rayon's try_fold and try_reduce```
/// The `try_fold_and_reduce` function can only be called by a iter with
/// `Result<T, E>` item type because the `fold_op` must meet the trait
/// bounds of both `try_fold` and `try_reduce` from rayon.
fn try_fold_and_reduce(
self,
identity: impl Fn() -> T + Send + Sync,