From 6637a0c0ca80594d1cf47ddd7e6d20747be32136 Mon Sep 17 00:00:00 2001 From: Harshil Jain Date: Sat, 22 Jan 2022 21:13:59 +0530 Subject: [PATCH] doc: improve process & os docs to give descriptive information about the platform property --- doc/api/os.md | 2 +- doc/api/process.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/api/os.md b/doc/api/os.md index 19d0528b0ea85f..3578bde9cdac53 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -301,7 +301,7 @@ added: v0.5.0 * Returns: {string} -Returns a string identifying the operating system platform. The value is set +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'`. diff --git a/doc/api/process.md b/doc/api/process.md index 1558abe7797a6e..970e25530d9aaf 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2612,8 +2612,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. +The `process.platform` property returns a string identifying the operating system platform for which the Node.js binary was compiled. Currently possible values are: