Commit 53684e4
doc: add parallelism note to os.cpus()
With the introduction of os.availableParallelism(), users should
no longer rely on os.cpus().length to determine the amount of
available parallelism. This commit adds a note to the os.cpus()
docs.
PR-URL: #45895
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>1 parent b2facef commit 53684e4
1 file changed
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -140,6 +140,10 @@ The properties included on each object include: | |||
| 140 | 140 | `nice` values are POSIX-only. On Windows, the `nice` values of all processors | |
| 141 | 141 | are always 0. | |
| 142 | 142 | ||
| 143 | + `os.cpus().length` should not be used to calculate the amount of parallelism | ||
| 144 | + available to an application. Use | ||
| 145 | + [`os.availableParallelism()`](#osavailableparallelism) for this purpose. | ||
| 146 | + | ||
| 143 | 147 | ## `os.devNull` | |
| 144 | 148 | ||
| 145 | 149 | <!-- YAML | |
0 commit comments