Skip to content

Commit

Permalink
doc: explain path.format expected properties
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
eversojk authored and benjamingr committed Mar 22, 2016
1 parent e301f97 commit d16d904
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/path.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ path.extname('.index')

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

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

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

0 comments on commit d16d904

Please sign in to comment.