From 9c96d7f4fdbcd7bb138455f61ec6137dd56bdca3 Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Wed, 18 Oct 2017 12:30:19 +0700 Subject: [PATCH] doc: clarify os.cpus() returns logical CPU cores Original text implied it returns physical cpu cores. This is misleading as `os.cpus().length` is often used to get the CPU core count in Node.js. In reality that will return the thread count which may not be what the user intended. PR-URL: https://github.com/nodejs/node/pull/16282 Fixes: https://github.com/nodejs/node/issues/16279 Reviewed-By: Joyee Cheung Reviewed-By: Bryan English Reviewed-By: Anna Henningsen --- doc/api/os.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/os.md b/doc/api/os.md index babb80e6f07b84..6160b0bbb1c71d 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -58,7 +58,7 @@ added: v0.3.3 * Returns: {Array} The `os.cpus()` method returns an array of objects containing information about -each CPU/core installed. +each logical CPU core. The properties included on each object include: