diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 3cc162f6dc8300..6f98ad1fc8fb4e 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -43,7 +43,7 @@ * Instances should use camelCase. * Denote methods with parentheses: `socket.end()` instead of `socket.end`. * Function arguments or object properties should use the following format: - * ``` * `name` {type|type2} Optional description. **Default:** `value`. ``` + * ```* `name` {type|type2} Optional description. **Default:** `value`.``` * For example: * `byteOffset` {integer} Index of first byte to expose. **Default:** `0`. diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 2a254380f2b1f5..2d37c65b8d3b6b 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1458,7 +1458,7 @@ changes: * `value` {string|Buffer|Uint8Array|integer} What to search for. * `byteOffset` {integer} Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. **Default:** - [`buf.length`][]` - 1`. + `buf.length - 1`. * `encoding` {string} If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`. **Default:** `'utf8'`. diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index a9ac6e42541b12..17257674a3b546 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -440,7 +440,7 @@ check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started (either by preserving their name and email -address in the commit log, or by using an `Author: ` meta-data tag in the +address in the commit log, or by using an `Author:` meta-data tag in the commit. ### Approving a change diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md index f34c07cc151c59..584b1d2373ce1b 100644 --- a/doc/guides/writing-tests.md +++ b/doc/guides/writing-tests.md @@ -249,7 +249,7 @@ fs.readFile('test-file').then( ### Flags Some tests will require running Node.js with specific command line flags set. To -accomplish this, add a `// Flags: ` comment in the preamble of the +accomplish this, add a `// Flags:` comment in the preamble of the test followed by the flags. For example, to allow a test to require some of the `internal/*` modules, add the `--expose-internals` flag. A test that would require `internal/freelist` could start like this: diff --git a/test/README.md b/test/README.md index fcfafb492bc5d8..ad9d87a7e93051 100644 --- a/test/README.md +++ b/test/README.md @@ -15,7 +15,7 @@ For the tests to run on Windows, be sure to clone Node.js source code with the | Directory | Runs on CI | Purpose | | ------------------- | --------------- | --------------- | -| `abort` | Yes | Tests for when the ``` --abort-on-uncaught-exception ``` flag is used. | +| `abort` | Yes | Tests for when the `--abort-on-uncaught-exception` flag is used. | | `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. | | `async-hooks` | Yes | Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality. | | `benchmark` | No | Test minimal functionality of benchmarks. | @@ -28,12 +28,12 @@ For the tests to run on Windows, be sure to clone Node.js source code with the | `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. | | `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. | | `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. | -| `message` | Yes | Tests for messages that are output for various conditions (```console.log```, error messages etc.) | +| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) | | `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. | | `parallel` | Yes | Various tests that are able to be run in parallel. | | `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. | | `pummel` | No | Various tests for various modules / system functionality operating under load. | | `sequential` | Yes | Various tests that must not run in parallel. | | `testpy` | | Test configuration utility used by various test suites. | -| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in ```lib/internal/v8_prof_processor.js``` and ```lib/internal/v8_prof_polyfill.js```. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. | +| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. | | `v8-updates` | No | Tests for V8 performance integration. |