Commit 808f025
doc: use code markup/markdown in headers
This also allows us to remove backslash escaping for `[` and `]`
inside of header code, which makes the bare markdown more readable.
Refs: #31086
PR-URL: #31149
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 73717f2 commit 808f025
5 files changed
Lines changed: 141 additions & 99 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -14,9 +14,9 @@ codebase not related to stylistic issues. | |||
| 14 | 14 | * [Align function arguments vertically](#align-function-arguments-vertically) | |
| 15 | 15 | * [Initialization lists](#initialization-lists) | |
| 16 | 16 | * [CamelCase for methods, functions, and classes](#camelcase-for-methods-functions-and-classes) | |
| 17 | - * [snake\_case for local variables and parameters](#snake_case-for-local-variables-and-parameters) | ||
| 18 | - * [snake\_case\_ for private class fields](#snake_case_-for-private-class-fields) | ||
| 19 | - * [snake\_case for C-like structs](#snake_case-for-c-like-structs) | ||
| 17 | + * [`snake_case` for local variables and parameters](#snake_case-for-local-variables-and-parameters) | ||
| 18 | + * [`snake_case_` for private class fields](#snake_case_-for-private-class-fields) | ||
| 19 | + * [`snake_case` for C-like structs](#snake_case-for-c-like-structs) | ||
| 20 | 20 | * [Space after `template`](#space-after-template) | |
| 21 | 21 | * [Memory Management](#memory-management) | |
| 22 | 22 | * [Memory allocation](#memory-allocation) | |
@@ -155,15 +155,15 @@ class FooBar { | |||
| 155 | 155 | }; | |
| 156 | 156 | ``` | |
| 157 | 157 | ||
| 158 | - ### snake\_case for local variables and parameters | ||
| 158 | + ### `snake_case` for local variables and parameters | ||
| 159 | 159 | ||
| 160 | 160 | ```c++ | |
| 161 | 161 | int FunctionThatDoesSomething(const char* important_string) { | |
| 162 | 162 | const char* pointer_into_string = important_string; | |
| 163 | 163 | } | |
| 164 | 164 | ``` | |
| 165 | 165 | ||
| 166 | - ### snake\_case\_ for private class fields | ||
| 166 | + ### `snake_case_` for private class fields | ||
| 167 | 167 | ||
| 168 | 168 | ```c++ | |
| 169 | 169 | class Foo { | |
@@ -172,8 +172,9 @@ class Foo { | |||
| 172 | 172 | }; | |
| 173 | 173 | ``` | |
| 174 | 174 | ||
| 175 | - ### snake\_case for C-like structs | ||
| 176 | - For plain C-like structs snake_case can be used. | ||
| 175 | + ### `snake_case` for C-like structs | ||
| 176 | + | ||
| 177 | + For `plain C-like structs snake_case can be used. | ||
| 177 | 178 | ||
| 178 | 179 | ```c++ | |
| 179 | 180 | struct foo_bar { | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -74,21 +74,21 @@ The common.js module is used by benchmarks for consistency across repeated | |||
| 74 | 74 | tasks. It has a number of helpful functions and properties to help with | |
| 75 | 75 | writing benchmarks. | |
| 76 | 76 | ||
| 77 | - ### createBenchmark(fn, configs\[, options\]) | ||
| 77 | + ### `createBenchmark(fn, configs[, options])` | ||
| 78 | 78 | ||
| 79 | 79 | See [the guide on writing benchmarks](writing-and-running-benchmarks.md#basics-of-a-benchmark). | |
| 80 | 80 | ||
| 81 | - ### default\_http\_benchmarker | ||
| 81 | + ### `default_http_benchmarker` | ||
| 82 | 82 | ||
| 83 | 83 | The default benchmarker used to run HTTP benchmarks. | |
| 84 | 84 | See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). | |
| 85 | 85 | ||
| 86 | - ### PORT | ||
| 86 | + ### `PORT` | ||
| 87 | 87 | ||
| 88 | 88 | The default port used to run HTTP benchmarks. | |
| 89 | 89 | See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). | |
| 90 | 90 | ||
| 91 | - ### sendResult(data) | ||
| 91 | + ### `sendResult(data)` | ||
| 92 | 92 | ||
| 93 | 93 | Used in special benchmarks that can't use `createBenchmark` and the object | |
| 94 | 94 | it returns to accomplish what they need. This function reports timing | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5073,7 +5073,7 @@ changes: | |||
| 5073 | 5073 | ||
| 5074 | 5074 | The `Promise` is resolved with the [`fs.Stats`][] object for the given `path`. | |
| 5075 | 5075 | ||
| 5076 | - ### `fsPromises.symlink(target, path\[, type\])` | ||
| 5076 | + ### `fsPromises.symlink(target, path[, type])` | ||
| 5077 | 5077 | <!-- YAML | |
| 5078 | 5078 | added: v10.0.0 | |
| 5079 | 5079 | --> | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3249,7 +3249,7 @@ const server = http2.createServer((req, res) => { | |||
| 3249 | 3249 | }); | |
| 3250 | 3250 | ``` | |
| 3251 | 3251 | ||
| 3252 | - #### `response.setTimeout(msecs\[, callback\])` | ||
| 3252 | + #### `response.setTimeout(msecs[, callback])` | ||
| 3253 | 3253 | <!-- YAML | |
| 3254 | 3254 | added: v8.4.0 | |
| 3255 | 3255 | --> | |
0 commit comments