Permalink
Browse files

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: #16282
Fixes: #16279
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information...
lukechilds authored and targos committed Oct 18, 2017
1 parent 1daf517 commit 720ea94894fe5ac6d800dc18b540a14d7f69821c
Showing with 1 addition and 1 deletion.
  1. +1 −1 doc/api/os.md
View
@@ -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:

0 comments on commit 720ea94

Please sign in to comment.