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>
nodejs · Feb 7, 2022 · 30336c2 · 30336c2
1 parent 29678d6
commit 30336c2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/doc/api/os.md b/doc/api/os.md
@@ -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`][].
 

diff --git a/doc/api/process.md b/doc/api/process.md
@@ -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: