]> git.lizzy.rs Git - rust.git/commitdiff
Add doc aliases to `std::thread::available_parallelism`
authorYoshua Wuyts <yoshuawuyts@gmail.com>
Mon, 4 Oct 2021 09:04:01 +0000 (11:04 +0200)
committerYoshua Wuyts <yoshuawuyts@gmail.com>
Mon, 4 Oct 2021 09:13:39 +0000 (11:13 +0200)
library/std/src/thread/mod.rs

index b6b48208ac7b369f4f0a26a0755b4ea20bc3cbb9..e24a3cb898627e5121101ed0756d96955c4580b3 100644 (file)
@@ -1460,6 +1460,8 @@ fn _assert_both<T: Send + Sync>() {}
 ///
 /// let count = thread::available_parallelism().map(|n| n.get()).unwrap_or(1);
 /// ```
+#[doc(alias = "hardware_concurrency")] // Alias for C++ `std::thread::hardware_concurrency`.
+#[doc(alias = "available_concurrency")] // Alias for a name we gave this API on unstable.
 #[unstable(feature = "available_parallelism", issue = "74479")]
 pub fn available_parallelism() -> io::Result<NonZeroUsize> {
     imp::available_parallelism()