Skip to content

Commit

Permalink
doc: improve docs to give descriptive info for the platform property
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
twitharshil authored and ruyadorno committed Feb 7, 2022
1 parent 29678d6 commit 30336c2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions doc/api/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,10 @@ added: v0.5.0

* Returns: {string}

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

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

Expand Down
2 changes: 1 addition & 1 deletion doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2613,7 +2613,7 @@ added: v0.1.16
* {string}
The `process.platform` property returns a string identifying the operating
system platform on which the Node.js process is running.
system platform for which the Node.js binary was compiled.
Currently possible values are:
Expand Down

0 comments on commit 30336c2

Please sign in to comment.