8000 doc: remove "note that" from crypto.md · nodejs/node@898b69c · GitHub
[go: up one dir, main page]
Skip to content

Commit 898b69c

Browse files
Trotttargos
Trott
authored and
targos
committed
doc: remove "note that" from crypto.md
Refs: nodejs/remark-preset-lint-node#16 PR-URL: #28329 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent c41dbf5 commit 898b69c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

‎doc/api/crypto.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ added: v0.11.8
4444
SPKAC is a Certificate Signing Request mechanism originally implemented by
4545
Netscape and was specified formally as part of [HTML5's `keygen` element][].
4646

47-
Note that `<keygen>` is deprecated since [HTML 5.2][] and new projects
47+
`<keygen>` is deprecated since [HTML 5.2][] and new projects
4848
should not use this element anymore.
4949

5050
The `crypto` module provides the `Certificate` class for working with SPKAC
@@ -887,7 +887,7 @@ Sets the EC Diffie-Hellman public key.
887887
If `encoding` is provided `publicKey` is expected to
888888
be a string; otherwise a [`Buffer`][], `TypedArray`, or `DataView` is expected.
889889

890-
Note that there is not normally a reason to call this method because `ECDH`
890+
There is not normally a reason to call this method because `ECDH`
891891
only requires a private key and the other party's public key to compute the
892892
shared secret. Typically either [`ecdh.generateKeys()`][] or
893893
[`ecdh.setPrivateKey()`][] will be called. The [`ecdh.setPrivateKey()`][] method
@@ -1311,7 +1311,7 @@ object, the following additional properties can be passed:
13111311
* `crypto.constants.RSA_PKCS1_PADDING` (default)
13121312
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
13131313

1314-
Note that `RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
1314+
`RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
13151315
used to sign the message as specified in section 3.1 of [RFC 4055][], unless
13161316
an MGF1 hash function has been specified as part of the key in compliance with
13171317
section 3.3 of [RFC 4055][].
@@ -1415,7 +1415,7 @@ object, the following additional properties can be passed:
14151415
* `crypto.constants.RSA_PKCS1_PADDING` (default)
14161416
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
14171417

1418-
Note that `RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
1418+
`RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
14191419
used to verify the message as specified in section 3.1 of [RFC 4055][], unless
14201420
an MGF1 hash function has been specified as part of the key in compliance with
14211421
section 3.3 of [RFC 4055][].
@@ -2200,8 +2200,8 @@ crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {
22002200
An array of supported digest functions can be retrieved using
22012201
[`crypto.getHashes()`][].
22022202

2203-
Note that this API uses libuv's threadpool, which can have surprising and
2204-
negative performance implications for some applications, see the
2203+
This API uses libuv's threadpool, which can have surprising and
2204+
negative performance implications for some applications; see the
22052205
[`UV_THREADPOOL_SIZE`][] documentation for more information.
22062206

22072207
### crypto.pbkdf2Sync(password, salt, iterations, keylen, digest)
@@ -2417,8 +2417,8 @@ This should normally never take longer than a few milliseconds. The only time
24172417
when generating the random bytes may conceivably block for a longer period of
24182418
time is right after boot, when the whole system is still low on entropy.
24192419

2420-
Note that this API uses libuv's threadpool, which can have surprising and
2421-
negative performance implications for some applications, see the
2420+
This API uses libuv's threadpool, which can have surprising and
2421+
negative performance implications for some applications; see the
24222422
[`UV_THREADPOOL_SIZE`][] documentation for more information.
24232423

24242424
The asynchronous version of `crypto.randomBytes()` is carried out in a single
@@ -2538,8 +2538,8 @@ crypto.randomFill(c, (err, buf) => {
25382538
});
25392539
```
25402540

2541-
Note that this API uses libuv's threadpool, which can have surprising and
2542-
negative performance implications for some applications, see the
2541+
This API uses libuv's threadpool, which can have surprising and
2542+
negative performance implications for some applications; see the
25432543
[`UV_THREADPOOL_SIZE`][] documentation for more information.
25442544

25452545
The asynchronous version of `crypto.randomFill()` is carried out in a single
@@ -2711,7 +2711,7 @@ additional properties can be passed:
27112711
* `crypto.constants.RSA_PKCS1_PADDING` (default)
27122712
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
27132713

2714-
Note that `RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
2714+
`RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
27152715
used to sign the message as specified in section 3.1 of [RFC 4055][].
27162716
* `saltLength`: {integer} - salt length for when padding is
27172717
`RSA_PKCS1_PSS_PADDING`. The special value
@@ -2762,7 +2762,7 @@ additional properties can be passed:
27622762
* `crypto.constants.RSA_PKCS1_PADDING` (default)
27632763
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
27642764

2765-
Note that `RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
2765+
`RSA_PKCS1_PSS_PADDING` will use MGF1 with the same hash function
27662766
used to sign the message as specified in section 3.1 of [RFC 4055][].
27672767
* `saltLength`: {integer} - salt length for when padding is
27682768
`RSA_PKCS1_PSS_PADDING`. The special value

0 commit comments

Comments
 (0)
0