Skip to content

Commit d16d904

Browse files
eversojkbenjamingr
authored andcommitted
doc: explain path.format expected properties
Explain the expected properties in path.format Fixes: #5746 PR-URL: #5801 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
1 parent e301f97 commit d16d904

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/path.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ path.extname('.index')
8888

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

91-
If `pathObject` has all expected properties, the returned string will be a
92-
concatenation of the `dir` property, the platform-dependent path separator, and
93-
the `base` property.
91+
If `pathObject` has `dir` and `base` properties, the returned string will
92+
be a concatenation of the `dir` property, the platform-dependent path separator,
93+
and the `base` property.
9494

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

0 commit comments

Comments
 (0)