FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: remove notice of dashes in V8 options · nodejs/node@f90cf19 · GitHub

/ node Public

Commit f90cf19

Browse files
lundibundi
authored and
George Adams
committed
doc: remove notice of dashes in V8 options
Previously only V8 options supported both dashes in them (making them equivalent), but now Node.js also supports both styles so the note can be removed. PR-URL: #23903 Refs: #18592 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>
1 parent d7b95f1 commit f90cf19

14 files changed

Lines changed: 20 additions & 34 deletions

‎doc/STYLE_GUIDE.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@
5151
* References to constructor instances should use camelCase.
5252
* References to methods should be used with parentheses: for example,
5353
`socket.end()` instead of `socket.end`.
54-
* To draw special attention to a note, adhere to the following guidelines:
55-
* Make the "Note:" label italic, i.e. `*Note*:`.
56-
* Use a capital letter after the "Note:" label.
57-
* Preferably, make the note a new paragraph for better visual distinction.
5854
* Function arguments or object properties should use the following format:
5955
* ``` * `name` {type|type2} Optional description. **Default:** `value`. ```
6056
<!--lint disable maximum-line-length remark-lint-->

‎doc/api/assert.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -426,10 +426,10 @@ the function does not return a promise, `assert.doesNotReject()` will return a
426426
rejected `Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases
427427
the error handler is skipped.
428428

429-
Please note: Using `assert.doesNotReject()` is actually not useful because there
430-
is little benefit by catching a rejection and then rejecting it again. Instead,
431-
consider adding a comment next to the specific code path that should not reject
432-
and keep error messages as expressive as possible.
429+
Using `assert.doesNotReject()` is actually not useful because there is little
430+
benefit in catching a rejection and then rejecting it again. Instead, consider
431+
adding a comment next to the specific code path that should not reject and keep
432+
error messages as expressive as possible.
433433

434434
If specified, `error` can be a [`Class`][], [`RegExp`][] or a validation
435435
function. See [`assert.throws()`][] for more details.
@@ -472,8 +472,8 @@ changes:
472472

473473
Asserts that the function `fn` does not throw an error.
474474

475-
Please note: Using `assert.doesNotThrow()` is actually not useful because there
476-
is no benefit by catching an error and then rethrowing it. Instead, consider
475+
Using `assert.doesNotThrow()` is actually not useful because there
476+
is no benefit in catching an error and then rethrowing it. Instead, consider
477477
adding a comment next to the specific code path that should not throw and keep
478478
error messages as expressive as possible.
479479

‎doc/api/child_process.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,9 +1056,9 @@ child process may not actually terminate the process.
10561056

10571057
See kill(2) for reference.
10581058

1059-
Also note: on Linux, child processes of child processes will not be terminated
1059+
On Linux, child processes of child processes will not be terminated
10601060
when attempting to kill their parent. This is likely to happen when running a
1061-
new process in a shell or with use of the `shell` option of `ChildProcess`:
1061+
new process in a shell or with the use of the `shell` option of `ChildProcess`:
10621062

10631063
```js
10641064
'use strict';

‎doc/api/crypto.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -845,7 +845,7 @@ const crypto = require('crypto');
845845
const alice = crypto.createECDH('secp256k1');
846846
const bob = crypto.createECDH('secp256k1');
847847

848-
// Note: This is a shortcut way to specify one of Alice's previous private
848+
// This is a shortcut way of specifying one of Alice's previous private
849849
// keys. It would be unwise to use such a predictable private key in a real
850850
// application.
851851
alice.setPrivateKey(

‎doc/api/dgram.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ added: v8.6.0
419419

420420
* `multicastInterface` {string}
421421

422-
*Note: All references to scope in this section are referring to
422+
*All references to scope in this section are referring to
423423
[IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP
424424
with a scope index is written as `'IP%scope'` where scope is an interface name
425425
or interface number.*

‎doc/api/domain.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ if (cluster.isMaster) {
122122
d.on('error', (er) => {
123123
console.error(`error ${er.stack}`);
124124

125-
// Note: We're in dangerous territory!
125+
// We're in dangerous territory!
126126
// By definition, something unexpected occurred,
127127
// which we probably didn't want.
128128
// Anything can happen now! Be very careful!

‎doc/api/path.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ path.posix.basename('/tmp/myfile.html');
5454
// Returns: 'myfile.html'
5555
```
5656

57-
*Note:* On Windows Node.js follows the concept of per-drive working directory.
57+
On Windows Node.js follows the concept of per-drive working directory.
5858
This behavior can be observed when using a drive path without a backslash. For
5959
example, `path.resolve('c:\\')` can potentially return a different result than
6060
`path.resolve('c:')`. For more information, see

‎doc/api/vm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<!--name=vm-->
88

99
The `vm` module provides APIs for compiling and running code within V8 Virtual
10-
Machine contexts. **Note that the `vm` module is not a security mechanism. Do
10+
Machine contexts. **The `vm` module is not a security mechanism. Do
1111
not use it to run untrusted code**. The term "sandbox" is used throughout these
1212
docs simply to refer to a separate context, and does not confer any security
1313
guarantees.

‎doc/guides/backporting-to-release-lines.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Each release line has a staging branch that the releaser will use as a scratch
66
pad while preparing a release. The branch name is formatted as follows:
77
`vN.x-staging` where `N` is the major release number.
88

9-
*Note*: For the active staging branches see the [Release Schedule][].
9+
For the active staging branches see the [Release Schedule][].
1010

1111
## What needs to be backported?
1212

‎doc/guides/maintaining-V8.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ to be cherry-picked in the Node.js repository and V8-CI must test the change.
228228
* Open a cherry-pick PR on `nodejs/node` targeting the *vY.x-staging* branch
229229
and notify the `@nodejs/v8` team.
230230
* Run the Node.js [V8 CI] in addition to the [Node.js CI].
231-
Note: The CI uses the `test-v8` target in the `Makefile`, which uses
231+
The CI uses the `test-v8` target in the `Makefile`, which uses
232232
`tools/make-v8.sh` to reconstruct a git tree in the `deps/v8` directory to
233233
run V8 tests.
234234

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL