Skip to content

Commit a23b5cb

Browse files
Trotttargos
authored andcommitted
doc: prepare miscellaneous docs for new markdown lint rules
Prepare the final few documents that haven't been updated to always use `[]` with reference links and to escape `[` and `]` for things that aren't links in markdown files. PR-URL: #29963 Reviewed-By: Masashi Hirano <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]>
1 parent aec8e77 commit a23b5cb

File tree

4 files changed

+145
-143
lines changed

4 files changed

+145
-143
lines changed

CPP_STYLE_GUIDE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ Use explicit comparisons to `nullptr` when testing pointers, i.e.
206206

207207
### Ownership and Smart Pointers
208208

209-
* [R.20]: Use `std::unique_ptr` or `std::shared_ptr` to represent ownership
210-
* [R.21]: Prefer `unique_ptr` over `shared_ptr` unless you need to share
209+
* [R.20][]: Use `std::unique_ptr` or `std::shared_ptr` to represent ownership
210+
* [R.21][]: Prefer `unique_ptr` over `shared_ptr` unless you need to share
211211
ownership
212212

213213
Use `std::unique_ptr` to make ownership transfer explicit. For example:
@@ -286,8 +286,8 @@ data[0] = 12345;
286286

287287
Further reading:
288288

289-
* [ES.48]: Avoid casts
290-
* [ES.49]: If you must use a cast, use a named cast
289+
* [ES.48][]: Avoid casts
290+
* [ES.49][]: If you must use a cast, use a named cast
291291

292292
### Using `auto`
293293

benchmark/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The common.js module is used by benchmarks for consistency across repeated
7474
tasks. It has a number of helpful functions and properties to help with
7575
writing benchmarks.
7676

77-
### createBenchmark(fn, configs[, options])
77+
### createBenchmark(fn, configs\[, options\])
7878

7979
See [the guide on writing benchmarks](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark).
8080

0 commit comments

Comments
 (0)