1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: format exponents better

Browse Source 
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: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Tobias Nießen 2020-09-04 11:45:16 +02:00 committed by Rich Trott
parent 6d9a3162bf
commit 699fae1f2c
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/buffer.md
View File

@ -3137,8 +3137,8 @@ added: v8.2.0
* {integer} The largest size allowed for a single `Buffer` instance.
On 32-bit architectures, this value currently is `(2^30)-1` (~1GB).
On 64-bit architectures, this value currently is `(2^31)-1` (~2GB).
On 32-bit architectures, this value currently is 2<sup>30</sup> - 1 (~1GB).
On 64-bit architectures, this value currently is 2<sup>31</sup> - 1 (~2GB).
This value is also available as [`buffer.kMaxLength`][].

2
doc/api/crypto.md
View File

@ -2813,7 +2813,7 @@ added: REPLACEME
Return a random integer `n` such that `min <= n < max`. This
implementation avoids [modulo bias][].
The range (`max - min`) must be less than `2^48`. `min` and `max` must
The range (`max - min`) must be less than 2<sup>48</sup>. `min` and `max` must
be safe integers.
If the `callback` function is not provided, the random integer is

9
doc/api/n-api.md
View File

@ -2385,8 +2385,8 @@ This API is used to convert from the C `int64_t` type to the JavaScript
The JavaScript `Number` type is described in [Section 6.1.6][]
of the ECMAScript Language Specification. Note the complete range of `int64_t`
cannot be represented with full precision in JavaScript. Integer values
outside the range of [`Number.MIN_SAFE_INTEGER`][] `-(2^53 - 1)` -
[`Number.MAX_SAFE_INTEGER`][] `(2^53 - 1)` will lose precision.
outside the range of [`Number.MIN_SAFE_INTEGER`][] `-(2**53 - 1)` -
[`Number.MAX_SAFE_INTEGER`][] `(2**53 - 1)` will lose precision.
#### napi_create_double
<!-- YAML
@ -2932,7 +2932,7 @@ of the given JavaScript `Number`.
If the number exceeds the range of the 32 bit integer, then the result is
truncated to the equivalent of the bottom 32 bits. This can result in a large
positive number becoming a negative number if the value is > 2^31 -1.
positive number becoming a negative number if the value is > 2<sup>31</sup> - 1.
Non-finite number values (`NaN`, `+Infinity`, or `-Infinity`) set the
result to zero.
@ -2961,7 +2961,8 @@ This API returns the C `int64` primitive equivalent of the given JavaScript
`Number`.
`Number` values outside the range of [`Number.MIN_SAFE_INTEGER`][]
`-(2^53 - 1)` - [`Number.MAX_SAFE_INTEGER`][] `(2^53 - 1)` will lose precision.
`-(2**53 - 1)` - [`Number.MAX_SAFE_INTEGER`][] `(2**53 - 1)` will lose
precision.
Non-finite number values (`NaN`, `+Infinity`, or `-Infinity`) set the
result to zero.