Skip to content

Commit 9616fd5

Browse files
twitharshildanielleadams
authored andcommitted
doc: improve docs to give descriptive info for the platform property
PR-URL: #41650 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Tierney Cyren <[email protected]>
1 parent 4d8ee8e commit 9616fd5

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
@@ -299,9 +299,10 @@ added: v0.5.0
299299

300300
* Returns: {string}
301301

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

306307
The return value is equivalent to [`process.platform`][].
307308

doc/api/process.md

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

0 commit comments

Comments
 (0)