Skip to content

Commit 5676a35

Browse files
eversojkevanlucas
authored andcommitted
doc: explain path.format expected properties
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
1 parent 2977839 commit 5676a35

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/path.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ path.extname('.index')
8585

8686
Returns a path string from an object. This is the opposite of [`path.parse`][].
8787

88-
If `pathObject` has all expected properties, the returned string will be a
89-
concatenation of the `dir` property, the platform-dependent path separator, and
90-
the `base` property.
88+
If `pathObject` has `dir` and `base` properties, the returned string will
89+
be a concatenation of the `dir` property, the platform-dependent path separator,
90+
and the `base` property.
9191

9292
If the `dir` property is not supplied, the `root` property will be used as the
9393
`dir` property. However, it will be assumed that the `root` property already

0 commit comments

Comments
 (0)