doc: add a note about os.cpus() returning an empty list

[codedokode]

It is not obvious that in some cases cpus() returns an empty list and this has caused a bug before: isaacs/promise-call-limit#11

[bnoordhuis]

Rather than going into platform-specific details, I'd change this line:

Returns an array of objects containing information about each logical CPU core.

And append something like:

The array can be empty if no CPU information is available.

Node gets its data from libuv and libuv doesn't document it reads from /proc so it'd be odd to mention that in our docs.

OTOH, mentioning /proc does give readers a hint to mount procfs. (On the other other hand, that's unlikely to be actionable on Android.) Let's say I'm -0 on the current wording.

[Trott]

Rather than going into platform-specific details, I'd change this line:

Returns an array of objects containing information about each logical CPU core.

And append something like:

The array can be empty if no CPU information is available.

Node gets its data from libuv and libuv doesn't document it reads from /proc so it'd be odd to mention that in our docs.

OTOH, mentioning /proc does give readers a hint to mount procfs. (On the other other hand, that's unlikely to be actionable on Android.) Let's say I'm -0 on the current wording.

@bnoordhuis I've reworked this along the lines of your suggest. PTAL.

[bnoordhuis]

"file system" but otherwise LGTM :)

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/47363
✔  Done loading data for nodejs/node/pull/47363
----------------------------------- PR info ------------------------------------
Title      doc: add a note about os.cpus() returning an empty list (#47363)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     codedokode:codedokode-patch-1 -> nodejs:main
Labels     doc, os, commit-queue-squash
Commits    2
 - doc: add a note about os.cpus() returning an empty list
 - Update doc/api/os.md
Committers 2
 - Rich Trott 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/47363
Reviewed-By: Ben Noordhuis 
Reviewed-By: Rich Trott 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/47363
Reviewed-By: Ben Noordhuis 
Reviewed-By: Rich Trott 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 01 Apr 2023 12:39:35 GMT
   ✔  Approvals: 2
   ✔  - Ben Noordhuis (@bnoordhuis) (TSC): https://github.com/nodejs/node/pull/47363#pullrequestreview-1370467845
   ✔  - Rich Trott (@Trott) (TSC): https://github.com/nodejs/node/pull/47363#pullrequestreview-1371525436
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
   ⚠  PR author is a new contributor: @codedokode([email protected])
   ⚠  - commit 05afb4639190 is authored by [email protected]
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/4610991181

[Trott]

Landed in dfbad86

[Trott]

Thanks for the contribution! 🚀