From a2bac24357a9ed1ce684915488caeb36bfa8b21e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 7 Sep 2019 22:44:35 -0400 Subject: [PATCH] doc: indenting child list items for remark-lint Child items not aligned to parent are flagged by list-item-bullet-indent --- doc/api/modules.md | 2 +- doc/api/n-api.md | 6 +++--- doc/changelogs/CHANGELOG_ARCHIVE.md | 1 + doc/changelogs/CHANGELOG_V5.md | 2 +- doc/changelogs/CHANGELOG_V7.md | 18 +++++++++--------- doc/guides/contributing/pull-requests.md | 4 ++-- 6 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/api/modules.md b/doc/api/modules.md index b6afe80a0dfeca..bffea8db7eb206 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -495,7 +495,7 @@ By doing this, Node.js achieves a few things: - It keeps top-level variables (defined with `var`, `const` or `let`) scoped to the module rather than the global object. - It helps to provide some global-looking variables that are actually specific -to the module, such as: + to the module, such as: - The `module` and `exports` objects that the implementor can use to export values from the module. - The convenience variables `__filename` and `__dirname`, containing the diff --git a/doc/api/n-api.md b/doc/api/n-api.md index b8f9d7c0b53a69..30ea0bd9b78fcf 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -3974,13 +3974,13 @@ Returns `napi_ok` if the API succeeded. N-API offers a way to "wrap" C++ classes and instances so that the class constructor and methods can be called from JavaScript. - 1. The [`napi_define_class`][] API defines a JavaScript class with constructor, +1. The [`napi_define_class`][] API defines a JavaScript class with constructor, static properties and methods, and instance properties and methods that correspond to the C++ class. - 2. When JavaScript code invokes the constructor, the constructor callback +2. When JavaScript code invokes the constructor, the constructor callback uses [`napi_wrap`][] to wrap a new C++ instance in a JavaScript object, then returns the wrapper object. - 3. When JavaScript code invokes a method or property accessor on the class, +3. When JavaScript code invokes a method or property accessor on the class, the corresponding `napi_callback` C++ function is invoked. For an instance callback, [`napi_unwrap`][] obtains the C++ instance that is the target of the call. diff --git a/doc/changelogs/CHANGELOG_ARCHIVE.md b/doc/changelogs/CHANGELOG_ARCHIVE.md index 7ac84ca05d8f50..f403042ff868e1 100644 --- a/doc/changelogs/CHANGELOG_ARCHIVE.md +++ b/doc/changelogs/CHANGELOG_ARCHIVE.md @@ -3438,6 +3438,7 @@ https://github.com/nodejs/node/commit/726865af7bbafe58435986f4a193ff11c84e4bfe - Move node.dns into module "dns" - Move node.fs into module "posix" - process is no longer the global object. GLOBAL is. + For more information on the API changes see: http://thread.gmane.org/gmane.comp.lang.javascript.nodejs/6 http://thread.gmane.org/gmane.comp.lang.javascript.nodejs/14 diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md index 5fb784162f318d..1e336d436faf8c 100644 --- a/doc/changelogs/CHANGELOG_V5.md +++ b/doc/changelogs/CHANGELOG_V5.md @@ -421,7 +421,7 @@ https://github.com/nodejs/node/pull/5655 * **v8**: backport fb4ccae from v8 upstream (Vladimir Krivosheev) #4231 - breakout events from v8 to offer better support for external debuggers * **zlib**: add support for concatenated members (Kári Tristan Helgason) -https://github.com/nodejs/node/pull/5120 + https://github.com/nodejs/node/pull/5120 * Previously, if multiple members were in the same archive, only the first would be read. The others are no longer thrown away. ### Commits diff --git a/doc/changelogs/CHANGELOG_V7.md b/doc/changelogs/CHANGELOG_V7.md index 7c903c35fb331b..0145381278e285 100644 --- a/doc/changelogs/CHANGELOG_V7.md +++ b/doc/changelogs/CHANGELOG_V7.md @@ -57,17 +57,17 @@ for details on patched vulnerabilities. * **build**: - Disable V8 snapshots - The hashseed embedded in the snapshot is currently the same for all runs of the binary. This opens node up to -collision attacks which could result in a Denial of Service. We have -temporarily disabled snapshots until a more robust solution is found -(Ali Ijaz Sheikh) + collision attacks which could result in a Denial of Service. We have + temporarily disabled snapshots until a more robust solution is found + (Ali Ijaz Sheikh) * **deps**: - CVE-2017-1000381 - The c-ares function ares_parse_naptr_reply(), which is used for parsing NAPTR responses, could be triggered to -read memory outside of the given input buffer if the passed in DNS -response packet was crafted in a particular way. This patch checks that -there is enough data for the required elements of an NAPTR record (2 -int16, 3 bytes for string lengths) before processing a record. (David -Drysdale) + read memory outside of the given input buffer if the passed in DNS + response packet was crafted in a particular way. This patch checks that + there is enough data for the required elements of an NAPTR record (2 + int16, 3 bytes for string lengths) before processing a record. (David + Drysdale) ### Commits @@ -1552,7 +1552,7 @@ Thank you to @italoacasas for preparing the majority of this release. * **buffer**: - Reverted the runtime deprecation of calling `Buffer()` without `new`. (Anna Henningsen) [#9529](https://github.com/nodejs/node/pull/9529) - Fixed `buffer.transcode()` for single-byte character -encodings to `UCS2`. (Anna Henningsen) [#9838](https://github.com/nodejs/node/pull/9838) + encodings to `UCS2`. (Anna Henningsen) [#9838](https://github.com/nodejs/node/pull/9838) * **promise**: `--trace-warnings` now produces useful stacktraces for Promise warnings. (Anna Henningsen) [#9525](https://github.com/nodejs/node/pull/9525) * **repl**: Fixed a bug preventing correct parsing of generator functions. (Teddy Katz) [#9852](https://github.com/nodejs/node/pull/9852) * **V8**: Fixed a significant `instanceof` performance regression. (Franziska Hinkelmann) [#9730](https://github.com/nodejs/node/pull/9730) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index c452b49f83db49..aeb249637566a5 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -158,8 +158,8 @@ A good commit message should describe what changed and why. 3. Wrap all other lines at 72 columns (except for long URLs). 4. If your patch fixes an open issue, you can add a reference to it at the end -of the log. Use the `Fixes:` prefix and the full issue URL. For other references -use `Refs:`. + of the log. Use the `Fixes:` prefix and the full issue URL. For other + references use `Refs:`. Examples: - `Fixes: https://github.com/nodejs/node/issues/1337`