diff options
| author | Luke Childs <lukechilds123@gmail.com> | 2017-10-18 12:30:19 +0700 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2017-11-28 13:10:34 +0900 |
| commit | 9c96d7f4fdbcd7bb138455f61ec6137dd56bdca3 (patch) | |
| tree | b7a5ff87cadad42d76b5ef4f0875da50ffb17cb5 /doc | |
| parent | c26abc8e94c34b3a1f3dd59eead355d3f73188ca (diff) | |
| download | node-new-9c96d7f4fdbcd7bb138455f61ec6137dd56bdca3.tar.gz | |
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 <joyeec9h3@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/os.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/os.md b/doc/api/os.md index babb80e6f0..6160b0bbb1 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: |