Skip to content

Commit

Permalink
Merge #486
Browse files Browse the repository at this point in the history
486: rayon-core: convert README.md to LF line break r=cuviper a=ignatenkobrain

Signed-off-by: Igor Gnatenko <i.gnatenko.brain@gmail.com>
  • Loading branch information
bors[bot] committed Dec 3, 2017
2 parents 11d7599 + de1d733 commit 5bf5134
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions rayon-core/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Rayon-core represents the "core, stable" APIs of Rayon: join, scope, and so forth, as well as the ability to create custom thread-pools with ThreadPool.

Maybe worth mentioning: users are not necessarily intended to directly access rayon-core; all its APIs are mirror in the rayon crate. To that end, the examples in the docs use rayon::join and so forth rather than rayon_core::join.

rayon-core aims to never, or almost never, have a breaking change to its API, because each revision of rayon-core also houses the global thread-pool (and hence if you have two simultaneous versions of rayon-core, you have two thread-pools).

Please see [Rayon Docs] for details about using Rayon.

[Rayon Docs]: https://docs.rs/rayon/
Rayon-core represents the "core, stable" APIs of Rayon: join, scope, and so forth, as well as the ability to create custom thread-pools with ThreadPool.

Maybe worth mentioning: users are not necessarily intended to directly access rayon-core; all its APIs are mirror in the rayon crate. To that end, the examples in the docs use rayon::join and so forth rather than rayon_core::join.

rayon-core aims to never, or almost never, have a breaking change to its API, because each revision of rayon-core also houses the global thread-pool (and hence if you have two simultaneous versions of rayon-core, you have two thread-pools).

Please see [Rayon Docs] for details about using Rayon.

[Rayon Docs]: https://docs.rs/rayon/

0 comments on commit 5bf5134

Please sign in to comment.