diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index b535d2babcdd24..efc997f1853710 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -61,6 +61,10 @@ * References to constructor instances should use camelCase. * References to methods should be used with parentheses: for example, `socket.end()` instead of `socket.end`. +* To draw special attention to a note, adhere to the following guidelines: + * Make the "Note:" label italic, i.e. `*Note*:`. + * Use a capital letter after the "Note:" label. + * Preferably, make the note a new paragraph for better visual distinction. [plugin]: http://editorconfig.org/#download [Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma diff --git a/doc/api/addons.md b/doc/api/addons.md index 772c3c77645869..8c08c5492e8c74 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -113,13 +113,13 @@ specifically to compile Node.js Addons. } ``` -*Note: A version of the `node-gyp` utility is bundled and distributed with +*Note*: A version of the `node-gyp` utility is bundled and distributed with Node.js as part of `npm`. This version is not made directly available for developers to use and is intended only to support the ability to use the `npm install` command to compile and install Addons. Developers who wish to use `node-gyp` directly can install it using the command `npm install -g node-gyp`. See the `node-gyp` [installation instructions][] for -more information, including platform-specific requirements.* +more information, including platform-specific requirements. Once the `binding.gyp` file has been created, use `node-gyp configure` to generate the appropriate project build files for the current platform. This diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 9b3f3f8b4b751b..1a61d79e350c33 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -193,11 +193,11 @@ The character encodings currently supported by Node.js include: * `'hex'` - Encode each byte as two hexadecimal characters. -_Note_: Today's browsers follow the [WHATWG spec] which aliases both 'latin1' and -ISO-8859-1 to win-1252. This means that while doing something like `http.get()`, -if the returned charset is one of those listed in the WHATWG spec it's possible -that the server actually returned win-1252-encoded data, and using `'latin1'` -encoding may incorrectly decode the characters. +*Note*: Today's browsers follow the [WHATWG spec] which aliases both 'latin1' +and ISO-8859-1 to win-1252. This means that while doing something like +`http.get()`, if the returned charset is one of those listed in the WHATWG spec +it's possible that the server actually returned win-1252-encoded data, and +using `'latin1'` encoding may incorrectly decode the characters. ## Buffers and TypedArray -_Note: usage of `util.inherits()` is discouraged. Please use the ES6 `class` and -`extends` keywords to get language level inheritance support. Also note that -the two styles are [semantically incompatible][]._ +*Note*: Usage of `util.inherits()` is discouraged. Please use the ES6 `class` +and `extends` keywords to get language level inheritance support. Also note +that the two styles are [semantically incompatible][]. * `constructor` {Function} * `superConstructor` {Function} diff --git a/doc/api/zlib.md b/doc/api/zlib.md index f889914bb0ba56..e159a70ce77bd8 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -54,8 +54,8 @@ the compression encodings accepted by the client. The [`Content-Encoding`][] header is used to identify the compression encodings actually applied to a message. -**Note: the examples given below are drastically simplified to show -the basic concept.** Using `zlib` encoding can be expensive, and the results +*Note*: the examples given below are drastically simplified to show +the basic concept. Using `zlib` encoding can be expensive, and the results ought to be cached. See [Memory Usage Tuning][] for more information on the speed/memory/compression tradeoffs involved in `zlib` usage. @@ -100,7 +100,7 @@ http.createServer((request, response) => { acceptEncoding = ''; } - // Note: this is not a conformant accept-encoding parser. + // Note: This is not a conformant accept-encoding parser. // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 if (acceptEncoding.match(/\bdeflate\b/)) { response.writeHead(200, { 'Content-Encoding': 'deflate' }); @@ -437,7 +437,7 @@ added: v0.5.8 Returns a new [DeflateRaw][] object with an [options][]. -**Note:** The zlib library rejects requests for 256-byte windows (i.e., +*Note*: The zlib library rejects requests for 256-byte windows (i.e., `{ windowBits: 8 }` in `options`). An `Error` will be thrown when creating a [DeflateRaw][] object with this specific value of the `windowBits` option. diff --git a/doc/changelogs/CHANGELOG_V010.md b/doc/changelogs/CHANGELOG_V010.md index 1d3cde8b4914c4..2b247a12e70f8e 100644 --- a/doc/changelogs/CHANGELOG_V010.md +++ b/doc/changelogs/CHANGELOG_V010.md @@ -70,7 +70,7 @@ * [io.js](CHANGELOG_IOJS.md) * [Archive](CHANGELOG_ARCHIVE.md) -**Note:** Node.js v0.10 is covered by the +*Note*: Node.js v0.10 is covered by the [Node.js Long Term Support Plan](https://github.com/nodejs/LTS) and will be maintained until October 2016. diff --git a/doc/changelogs/CHANGELOG_V012.md b/doc/changelogs/CHANGELOG_V012.md index cbacd47f69237e..436ec48c9c20ff 100644 --- a/doc/changelogs/CHANGELOG_V012.md +++ b/doc/changelogs/CHANGELOG_V012.md @@ -38,7 +38,7 @@ * [io.js](CHANGELOG_IOJS.md) * [Archive](CHANGELOG_ARCHIVE.md) -**Note:** Node.js v0.12 is covered by the +*Note*: Node.js v0.12 is covered by the [Node.js Long Term Support Plan](https://github.com/nodejs/LTS) and will be maintained until December 31st, 2016. diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md index 6c8aa895b5ebeb..94385c032ae14c 100644 --- a/doc/changelogs/CHANGELOG_V4.md +++ b/doc/changelogs/CHANGELOG_V4.md @@ -57,7 +57,7 @@ * [Archive](CHANGELOG_ARCHIVE.md) -**Note:** Node.js v4 is covered by the +*Note*: Node.js v4 is covered by the [Node.js Long Term Support Plan](https://github.com/nodejs/LTS) and will be supported actively until April 2017 and maintained until April 2018. diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md index 5fefbcc81a6b85..fdf265206fd6be 100644 --- a/doc/changelogs/CHANGELOG_V5.md +++ b/doc/changelogs/CHANGELOG_V5.md @@ -38,7 +38,7 @@ * [io.js](CHANGELOG_IOJS.md) * [Archive](CHANGELOG_ARCHIVE.md) -**Note:** Official support for the v5 release line is scheduled to expire +*Note*: Official support for the v5 release line is scheduled to expire around June 2016. Users of v5 should upgrade to [Node.js v6](CHANGELOG_V6.md). diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md index 48a45c94e454c6..c084eebceee05c 100644 --- a/doc/changelogs/CHANGELOG_V6.md +++ b/doc/changelogs/CHANGELOG_V6.md @@ -45,7 +45,7 @@ * [io.js](CHANGELOG_IOJS.md) * [Archive](CHANGELOG_ARCHIVE.md) -**Note:** Node.js v6 is covered by the +*Note*: Node.js v6 is covered by the [Node.js Long Term Support Plan](https://github.com/nodejs/LTS) and will be supported actively until April 2018 and maintained until April 2019. diff --git a/doc/releases.md b/doc/releases.md index 6433eeeacb14b4..eafc906026d6b5 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -86,7 +86,7 @@ This macro is used to signal an ABI version for native addons. It currently has The general rule is to bump this version when there are _breaking ABI_ changes and also if there are non-trivial API changes. The rules are not yet strictly defined, so if in doubt, please confer with someone that will have a more informed perspective, such as a member of the NAN team. -**Note** that it is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. +*Note*: It is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. ### 3. Update the Changelog @@ -279,7 +279,8 @@ Use `tools/release.sh` to promote and sign the build. When run, it will perform If you didn't wait for ARM builds in the previous step before promoting the release, you should re-run `tools/release.sh` after the ARM builds have finished. That will move the ARM artifacts into the correct location. You will be prompted to re-sign SHASUMS256.txt. -Note: it is possible to only sign a release by running `./tools/release.sh -s vX.Y.Z`. +*Note*: It is possible to only sign a release by running +`./tools/release.sh -s vX.Y.Z`. ### 13. Check the Release