Skip to content

Commit

Permalink
Sort hidden imports in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
gendx committed Nov 15, 2024
1 parent e7a179f commit b2a7609
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 43 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

[![Crate](https://img.shields.io/crates/v/paralight.svg?logo=rust)](https://crates.io/crates/paralight)
[![Documentation](https://img.shields.io/docsrs/paralight?logo=rust)](https://docs.rs/paralight)
[![Minimum Rust 1.75.0](https://img.shields.io/crates/msrv/paralight/0.0.4.svg?logo=rust&color=orange)](https://releases.rs/docs/1.75.0/)
[![Lines of Code](https://www.aschey.tech/tokei/github/gendx/paralight?category=code&branch=0.0.4)](https://github.com/gendx/paralight/tree/0.0.4)
[![Dependencies](https://deps.rs/crate/paralight/0.0.4/status.svg)](https://deps.rs/crate/paralight/0.0.4)
[![License](https://img.shields.io/crates/l/paralight/0.0.4.svg)](https://github.com/gendx/paralight/blob/0.0.4/LICENSE)
[![Codecov](https://codecov.io/gh/gendx/paralight/branch/0.0.4/graph/badge.svg)](https://codecov.io/gh/gendx/paralight/tree/0.0.4)
[![Build Status](https://github.com/gendx/paralight/actions/workflows/build.yml/badge.svg?branch=0.0.4)](https://github.com/gendx/paralight/actions/workflows/build.yml)
[![Test Status](https://github.com/gendx/paralight/actions/workflows/tests.yml/badge.svg?branch=0.0.4)](https://github.com/gendx/paralight/actions/workflows/tests.yml)
[![Minimum Rust 1.75.0](https://img.shields.io/badge/rust-1.75.0%2B-orange.svg?logo=rust)](https://releases.rs/docs/1.75.0/)
[![Lines of Code](https://www.aschey.tech/tokei/github/gendx/paralight?category=code&branch=main)](https://github.com/gendx/paralight)
[![Dependencies](https://deps.rs/repo/github/gendx/paralight/status.svg)](https://deps.rs/repo/github/gendx/paralight)
[![License](https://img.shields.io/crates/l/paralight.svg)](https://github.com/gendx/paralight/blob/main/LICENSE)
[![Codecov](https://codecov.io/gh/gendx/paralight/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gendx/paralight/tree/main)
[![Build Status](https://github.com/gendx/paralight/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/gendx/paralight/actions/workflows/build.yml)
[![Test Status](https://github.com/gendx/paralight/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/gendx/paralight/actions/workflows/tests.yml)

This library allows you to distribute computation over slices (and other
*indexed* sources) among multiple threads. Each thread processes a subset of the
Expand Down
36 changes: 18 additions & 18 deletions src/iter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pub trait ParallelIterator: Sized {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIterator, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -78,7 +78,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -118,7 +118,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -146,7 +146,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -175,7 +175,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -198,7 +198,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
/// # use paralight::iter::{
/// # IntoParallelRefSource, ParallelIterator, ParallelIteratorExt, ParallelSourceExt,
/// # };
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # use std::rc::Rc;
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
Expand All @@ -225,7 +225,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # use std::collections::HashSet;
/// # use std::sync::Mutex;
/// # let mut thread_pool = ThreadPoolBuilder {
Expand Down Expand Up @@ -264,7 +264,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # use std::sync::atomic::{AtomicUsize, Ordering};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
Expand Down Expand Up @@ -299,7 +299,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -322,7 +322,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
/// # use paralight::iter::{
/// # IntoParallelRefSource, ParallelIterator, ParallelIteratorExt, ParallelSourceExt,
/// # };
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # use std::rc::Rc;
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
Expand Down Expand Up @@ -350,7 +350,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -385,7 +385,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -432,7 +432,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -466,7 +466,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -501,7 +501,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -548,7 +548,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -582,7 +582,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -612,7 +612,7 @@ pub trait ParallelIteratorExt: ParallelIterator {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down
28 changes: 14 additions & 14 deletions src/iter/source/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ pub trait IntoParallelRefSource<'data> {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -131,7 +131,7 @@ pub trait IntoParallelRefMutSource<'data> {
///
/// ```
/// # use paralight::iter::{IntoParallelRefMutSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -175,7 +175,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -205,7 +205,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -235,7 +235,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -265,7 +265,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -284,7 +284,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -316,7 +316,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -335,7 +335,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```should_panic
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -365,7 +365,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -384,7 +384,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand Down Expand Up @@ -415,7 +415,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -434,7 +434,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```should_panic
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// # let mut thread_pool = ThreadPoolBuilder {
/// # num_threads: ThreadCount::AvailableParallelism,
/// # range_strategy: RangeStrategy::WorkStealing,
Expand All @@ -461,7 +461,7 @@ pub trait ParallelSourceExt: ParallelSource {
///
/// ```
/// # use paralight::iter::{IntoParallelRefSource, ParallelIteratorExt, ParallelSourceExt};
/// # use paralight::{CpuPinningPolicy, ThreadCount, RangeStrategy, ThreadPoolBuilder};
/// # use paralight::{CpuPinningPolicy, RangeStrategy, ThreadCount, ThreadPoolBuilder};
/// let mut thread_pool = ThreadPoolBuilder {
/// num_threads: ThreadCount::AvailableParallelism,
/// range_strategy: RangeStrategy::WorkStealing,
Expand Down
Loading

0 comments on commit b2a7609

Please sign in to comment.