From b13cd9140d8d44a984e2d42b9c6fad6e86ba5f79 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. Fixes: https://github.com/nodejs/node/issues/16279 --- 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 38f1d25ab2..69852bf810 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: