Skip to content

Commit 2fe0f90

Browse files
TrottMylesBorins
authored andcommitted
doc,path: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent fcfcd1d commit 2fe0f90

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

doc/api/path.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ example, `path.resolve('c:\\')` can potentially return a different result than
6060
`path.resolve('c:')`. For more information, see
6161
[this MSDN page][MSDN-Rel-Path].
6262

63-
## path.basename(path\[, ext\])
63+
## `path.basename(path[, ext])`
6464
<!-- YAML
6565
added: v0.1.25
6666
changes:
@@ -88,7 +88,7 @@ path.basename('/foo/bar/baz/asdf/quux.html', '.html');
8888
A [`TypeError`][] is thrown if `path` is not a string or if `ext` is given
8989
and is not a string.
9090

91-
## path.delimiter
91+
## `path.delimiter`
9292
<!-- YAML
9393
added: v0.9.3
9494
-->
@@ -120,7 +120,7 @@ process.env.PATH.split(path.delimiter);
120120
// Returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']
121121
```
122122

123-
## path.dirname(path)
123+
## `path.dirname(path)`
124124
<!-- YAML
125125
added: v0.1.16
126126
changes:
@@ -143,7 +143,7 @@ path.dirname('/foo/bar/baz/asdf/quux');
143143

144144
A [`TypeError`][] is thrown if `path` is not a string.
145145

146-
## path.extname(path)
146+
## `path.extname(path)`
147147
<!-- YAML
148148
added: v0.1.25
149149
changes:
@@ -183,7 +183,7 @@ path.extname('.index.md');
183183

184184
A [`TypeError`][] is thrown if `path` is not a string.
185185

186-
## path.format(pathObject)
186+
## `path.format(pathObject)`
187187
<!-- YAML
188188
added: v0.11.15
189189
-->
@@ -247,7 +247,7 @@ path.format({
247247
// Returns: 'C:\\path\\dir\\file.txt'
248248
```
249249

250-
## path.isAbsolute(path)
250+
## `path.isAbsolute(path)`
251251
<!-- YAML
252252
added: v0.11.2
253253
-->
@@ -282,7 +282,7 @@ path.isAbsolute('.'); // false
282282

283283
A [`TypeError`][] is thrown if `path` is not a string.
284284

285-
## path.join(\[...paths\])
285+
## `path.join([...paths])`
286286
<!-- YAML
287287
added: v0.1.16
288288
-->
@@ -307,7 +307,7 @@ path.join('foo', {}, 'bar');
307307

308308
A [`TypeError`][] is thrown if any of the path segments is not a string.
309309

310-
## path.normalize(path)
310+
## `path.normalize(path)`
311311
<!-- YAML
312312
added: v0.1.23
313313
-->
@@ -350,7 +350,7 @@ path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
350350

351351
A [`TypeError`][] is thrown if `path` is not a string.
352352

353-
## path.parse(path)
353+
## `path.parse(path)`
354354
<!-- YAML
355355
added: v0.11.15
356356
-->
@@ -416,7 +416,7 @@ path.parse('C:\\path\\dir\\file.txt');
416416

417417
A [`TypeError`][] is thrown if `path` is not a string.
418418

419-
## path.posix
419+
## `path.posix`
420420
<!-- YAML
421421
added: v0.11.15
422422
-->
@@ -426,7 +426,7 @@ added: v0.11.15
426426
The `path.posix` property provides access to POSIX specific implementations
427427
of the `path` methods.
428428

429-
## path.relative(from, to)
429+
## `path.relative(from, to)`
430430
<!-- YAML
431431
added: v0.5.0
432432
changes:
@@ -463,7 +463,7 @@ path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
463463

464464
A [`TypeError`][] is thrown if either `from` or `to` is not a string.
465465

466-
## path.resolve(\[...paths\])
466+
## `path.resolve([...paths])`
467467
<!-- YAML
468468
added: v0.3.4
469469
-->
@@ -504,7 +504,7 @@ path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
504504

505505
A [`TypeError`][] is thrown if any of the arguments is not a string.
506506

507-
## path.sep
507+
## `path.sep`
508508
<!-- YAML
509509
added: v0.7.9
510510
-->
@@ -534,7 +534,7 @@ On Windows, both the forward slash (`/`) and backward slash (`\`) are accepted
534534
as path segment separators; however, the `path` methods only add backward
535535
slashes (`\`).
536536

537-
## path.toNamespacedPath(path)
537+
## `path.toNamespacedPath(path)`
538538
<!-- YAML
539539
added: v9.0.0
540540
-->
@@ -549,7 +549,7 @@ modifications.
549549
This method is meaningful only on Windows system. On POSIX systems, the
550550
method is non-operational and always returns `path` without modifications.
551551

552-
## path.win32
552+
## `path.win32`
553553
<!-- YAML
554554
added: v0.11.15
555555
-->

0 commit comments

Comments
 (0)