Commit f03a4d7
doc: format exponents better
The `2^n` notation is common in mathematics, but even then it often
requires parentheses or braces. In JavaScript and C++, the `^` operator
stands for bitwise xor, and should be avoided in the docs. In code tags,
the JavaScript operator `**` can be used. Otherwise, the `sup` tag can
be used for formatting.
PR-URL: #35050
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 791a85b commit f03a4d7
3 files changed
Lines changed: 8 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3137,8 +3137,8 @@ added: v8.2.0 | |||
| 3137 | 3137 | ||
| 3138 | 3138 | * {integer} The largest size allowed for a single `Buffer` instance. | |
| 3139 | 3139 | ||
| 3140 | - On 32-bit architectures, this value currently is `(2^30)-1` (~1GB). | ||
| 3141 | - On 64-bit architectures, this value currently is `(2^31)-1` (~2GB). | ||
| 3140 | + On 32-bit architectures, this value currently is 2<sup>30</sup> - 1 (~1GB). | ||
| 3141 | + On 64-bit architectures, this value currently is 2<sup>31</sup> - 1 (~2GB). | ||
| 3142 | 3142 | ||
| 3143 | 3143 | This value is also available as [`buffer.kMaxLength`][]. | |
| 3144 | 3144 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2805,7 +2805,7 @@ added: REPLACEME | |||
| 2805 | 2805 | Return a random integer `n` such that `min <= n < max`. This | |
| 2806 | 2806 | implementation avoids [modulo bias][]. | |
| 2807 | 2807 | ||
| 2808 | - The range (`max - min`) must be less than `2^48`. `min` and `max` must | ||
| 2808 | + The range (`max - min`) must be less than 2<sup>48</sup>. `min` and `max` must | ||
| 2809 | 2809 | be safe integers. | |
| 2810 | 2810 | ||
| 2811 | 2811 | If the `callback` function is not provided, the random integer is | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2382,8 +2382,8 @@ This API is used to convert from the C `int64_t` type to the JavaScript | |||
| 2382 | 2382 | The JavaScript `Number` type is described in [Section 6.1.6][] | |
| 2383 | 2383 | of the ECMAScript Language Specification. Note the complete range of `int64_t` | |
| 2384 | 2384 | cannot be represented with full precision in JavaScript. Integer values | |
| 2385 | - outside the range of [`Number.MIN_SAFE_INTEGER`][] `-(2^53 - 1)` - | ||
| 2386 | - [`Number.MAX_SAFE_INTEGER`][] `(2^53 - 1)` will lose precision. | ||
| 2385 | + outside the range of [`Number.MIN_SAFE_INTEGER`][] `-(2**53 - 1)` - | ||
| 2386 | + [`Number.MAX_SAFE_INTEGER`][] `(2**53 - 1)` will lose precision. | ||
| 2387 | 2387 | ||
| 2388 | 2388 | #### napi_create_double | |
| 2389 | 2389 | <!-- YAML | |
@@ -2929,7 +2929,7 @@ of the given JavaScript `Number`. | |||
| 2929 | 2929 | ||
| 2930 | 2930 | If the number exceeds the range of the 32 bit integer, then the result is | |
| 2931 | 2931 | truncated to the equivalent of the bottom 32 bits. This can result in a large | |
| 2932 | - positive number becoming a negative number if the value is > 2^31 -1. | ||
| 2932 | + positive number becoming a negative number if the value is > 2<sup>31</sup> - 1. | ||
| 2933 | 2933 | ||
| 2934 | 2934 | Non-finite number values (`NaN`, `+Infinity`, or `-Infinity`) set the | |
| 2935 | 2935 | result to zero. | |
@@ -2958,7 +2958,8 @@ This API returns the C `int64` primitive equivalent of the given JavaScript | |||
| 2958 | 2958 | `Number`. | |
| 2959 | 2959 | ||
| 2960 | 2960 | `Number` values outside the range of [`Number.MIN_SAFE_INTEGER`][] | |
| 2961 | - `-(2^53 - 1)` - [`Number.MAX_SAFE_INTEGER`][] `(2^53 - 1)` will lose precision. | ||
| 2961 | + `-(2**53 - 1)` - [`Number.MAX_SAFE_INTEGER`][] `(2**53 - 1)` will lose | ||
| 2962 | + precision. | ||
| 2962 | 2963 | ||
| 2963 | 2964 | Non-finite number values (`NaN`, `+Infinity`, or `-Infinity`) set the | |
| 2964 | 2965 | result to zero. | |
0 commit comments