From 30336c23b5e6162b8b43eb7cc3cf129b50b5c75e Mon Sep 17 00:00:00 2001 From: Harshil jain Date: Fri, 28 Jan 2022 05:42:01 +0530 Subject: [PATCH] doc: improve docs to give descriptive info for the platform property PR-URL: https://github.com/nodejs/node/pull/41650 Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen Reviewed-By: Mestery Reviewed-By: Tierney Cyren --- doc/api/os.md | 7 ++++--- doc/api/process.md | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/api/os.md b/doc/api/os.md index 19d0528b0ea85f..99c448a4b90888 100644 --- 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 index 1558abe7797a6e..61d48dfb1d61f8 100644 --- 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: