Skip to content

Commit c277908

Browse files
committed
doc: improve docs to give descriptive info for the platform property
1 parent 5aa4010 commit c277908

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
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

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

0 commit comments

Comments
 (0)