Skip to content

Commit

Permalink
Document always returning at least 1 core (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
daxpedda committed Mar 16, 2021
1 parent b423db0 commit a49a203
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/lib.rs
Expand Up @@ -47,6 +47,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
///
/// ```
Expand Down Expand Up @@ -75,6 +77,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.
Expand Down

0 comments on commit a49a203

Please sign in to comment.