aboutsummaryrefslogtreecommitdiff
path: root/lib/std/Thread.zig
diff options
context:
space:
mode:
Diffstat (limited to 'lib/std/Thread.zig')
-rw-r--r--lib/std/Thread.zig2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/std/Thread.zig b/lib/std/Thread.zig
index f587b15f86..3d78596f84 100644
--- a/lib/std/Thread.zig
+++ b/lib/std/Thread.zig
@@ -385,6 +385,8 @@ pub const CpuCountError = error{
};
/// Returns the platforms view on the number of logical CPU cores available.
+///
+/// Returned value guaranteed to be >= 1.
pub fn getCpuCount() CpuCountError!usize {
return try Impl.getCpuCount();
}