diff options
| author | Nick Schonning <nschonni@gmail.com> | 2019-08-26 23:52:08 -0400 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-09 20:55:14 -0700 |
| commit | 0d061e2d090c6aa8b2874289ecdfc28a4d0f2eff (patch) | |
| tree | 47865af688b77ad48360b299ce8d2b9a4a97ed3d /doc | |
| parent | b41989d03a38347a0ae018c5cbfbab898ba454fe (diff) | |
| download | android-node-v8-0d061e2d090c6aa8b2874289ecdfc28a4d0f2eff.tar.gz android-node-v8-0d061e2d090c6aa8b2874289ecdfc28a4d0f2eff.tar.bz2 android-node-v8-0d061e2d090c6aa8b2874289ecdfc28a4d0f2eff.zip | |
doc: remove spaces inside code span elements
Applies MarkdownLint MD038 rule
PR-URL: https://github.com/nodejs/node/pull/29329
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 2 | ||||
| -rw-r--r-- | doc/api/buffer.md | 2 | ||||
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 2 | ||||
| -rw-r--r-- | doc/guides/writing-tests.md | 2 |
4 files changed, 4 insertions, 4 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 3cc162f6dc..6f98ad1fc8 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`.``` <!--lint disable maximum-line-length remark-lint--> * For example: <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code> <!--lint enable maximum-line-length remark-lint--> diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 2a254380f2..713024a21b 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 a9ac6e4254..17257674a3 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 f34c07cc15..584b1d2373 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: |