Skip to content

Commit 30336c2

Browse files
twitharshilruyadorno
authored andcommittedFeb 7, 2022
doc: improve docs to give descriptive info for the platform property
PR-URL: #41650 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im>
1 parent 29678d6 commit 30336c2

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed
 

‎doc/api/os.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -301,9 +301,10 @@ added: v0.5.0
301301

302302
* Returns: {string}
303303

304-
Returns a string identifying the operating system platform. The value is set
305-
at compile time. Possible values are `'aix'`, `'darwin'`, `'freebsd'`,
306-
`'linux'`, `'openbsd'`, `'sunos'`, and `'win32'`.
304+
Returns a string identifying the operating system platform for which
305+
the Node.js binary was compiled. The value is set at compile time.
306+
Possible values are `'aix'`, `'darwin'`, `'freebsd'`,`'linux'`,
307+
`'openbsd'`, `'sunos'`, and `'win32'`.
307308

308309
The return value is equivalent to [`process.platform`][].
309310

‎doc/api/process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2613,7 +2613,7 @@ added: v0.1.16
26132613
* {string}
26142614
26152615
The `process.platform` property returns a string identifying the operating
2616-
system platform on which the Node.js process is running.
2616+
system platform for which the Node.js binary was compiled.
26172617
26182618
Currently possible values are:
26192619

0 commit comments

Comments
 (0)
Please sign in to comment.