Skip to content

Commit 7d6544c

Browse files
committed
Update description
This addresses the concerns raised in #837. Namely, the value returned by `os.arch` is the CPU architecture for which the Node.js binary was compiled, which may **not** be the same as the actual host CPU architecture (e.g., if a binary is run on a different architecture). This commit aims to address the ambiguity of the previous description.
1 parent 599458d commit 7d6544c

File tree

6 files changed

+8
-7
lines changed

6 files changed

+8
-7
lines changed

lib/node_modules/@stdlib/os/arch/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Architecture
2222

23-
> Operating system CPU architecture.
23+
> Operating system CPU architecture for which the JavaScript runtime binary was compiled.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var ARCH = require( '@stdlib/os/arch' );
3232

3333
#### ARCH
3434

35-
Operating system CPU architecture.
35+
Operating system CPU architecture for which the JavaScript runtime binary was compiled.
3636

3737
```javascript
3838
console.log( ARCH );

lib/node_modules/@stdlib/os/arch/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
{{alias}}
3-
Operating system CPU architecture.
3+
Operating system CPU architecture for which the JavaScript runtime binary
4+
was compiled.
45

56
Current possible values:
67

lib/node_modules/@stdlib/os/arch/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 2.0
2020

2121
/**
22-
* Operating system CPU architecture.
22+
* Operating system CPU architecture for which the JavaScript runtime binary was compiled.
2323
*
2424
* ## Notes
2525
*

lib/node_modules/@stdlib/os/arch/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Operating system CPU architecture.
22+
* Operating system CPU architecture for which the JavaScript runtime binary was compiled.
2323
*
2424
* @module @stdlib/os/arch
2525
*

lib/node_modules/@stdlib/os/arch/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var proc = require( 'process' );
2626
// MAIN //
2727

2828
/**
29-
* Operating system CPU architecture.
29+
* Operating system CPU architecture for which the JavaScript runtime binary was compiled.
3030
*
3131
* @constant
3232
* @type {string}

lib/node_modules/@stdlib/os/arch/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/os/arch",
33
"version": "0.0.0",
4-
"description": "Operating system CPU architecture.",
4+
"description": "Operating system CPU architecture for which the JavaScript runtime binary was compiled.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)