Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

doc: explain path.format expected properties

Browse Source 
Explain the expected properties in path.format

Fixes: https://github.com/nodejs/node/issues/5746
PR-URL: https://github.com/nodejs/node/pull/5801
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
This commit is contained in:
John Eversole 2016-03-19 09:59:15 -07:00 committed by Benjamin Gruenbaum
parent e301f979de
commit d16d9047ea
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/path.markdown
View File

@ -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