aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 6c8280f..20474af 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -28,7 +28,6 @@
//! [`rayon::ThreadPool`]: https://docs.rs/rayon/1.*/rayon/struct.ThreadPool.html
#![cfg_attr(test, deny(warnings))]
#![deny(missing_docs)]
-#![doc(html_root_url = "https://docs.rs/num_cpus/1.13.0")]
#![allow(non_snake_case)]
#[cfg(not(windows))]
@@ -47,6 +46,8 @@ use linux::{get_num_cpus, get_num_physical_cpus};
/// This function will get the number of logical cores. Sometimes this is different from the number
/// of physical cores (See [Simultaneous multithreading on Wikipedia][smt]).
///
+/// This will always return at least `1`.
+///
/// # Examples
///
/// ```
@@ -75,6 +76,8 @@ pub fn get() -> usize {
/// Returns the number of physical cores of the current system.
///
+/// This will always return at least `1`.
+///
/// # Note
///
/// Physical count is supported only on Linux, mac OS and Windows platforms.