diff options
| author | John Eversole <eversojk@gmail.com> | 2016-03-19 09:59:15 -0700 |
|---|---|---|
| committer | Myles Borins <mborins@us.ibm.com> | 2016-03-30 13:12:16 -0700 |
| commit | 79d26ae1964078ffeb8a9d211be7297e0f8b4c30 (patch) | |
| tree | 62cef6ad1248952f4fc9ce522806ddd1e3b4e827 /doc | |
| parent | e57355c2f499c92a56da616898376db79dcdc3eb (diff) | |
| download | nodejs-79d26ae1964078ffeb8a9d211be7297e0f8b4c30.tar.gz nodejs-79d26ae1964078ffeb8a9d211be7297e0f8b4c30.tar.bz2 nodejs-79d26ae1964078ffeb8a9d211be7297e0f8b4c30.zip | |
doc: explain path.format expected properties
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/path.markdown | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/path.markdown b/doc/api/path.markdown index 530dc440c..e691d0414 100644 --- a/doc/api/path.markdown +++ b/doc/api/path.markdown @@ -85,9 +85,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 |