diff options
| author | John Eversole <eversojk@gmail.com> | 2016-03-19 09:59:15 -0700 |
|---|---|---|
| committer | Benjamin Gruenbaum <inglor@gmail.com> | 2016-03-22 23:46:33 +0200 |
| commit | d16d9047eaa9f50d5dea5d7d42f6ae5b4369fe8b (patch) | |
| tree | 3f81ebe2840a5ec0929f3c8a05a5b972cb5dd897 /doc | |
| parent | e301f979de1f5eb2c075fddc965ba54bdab9ac59 (diff) | |
| download | android-node-v8-d16d9047eaa9f50d5dea5d7d42f6ae5b4369fe8b.tar.gz android-node-v8-d16d9047eaa9f50d5dea5d7d42f6ae5b4369fe8b.tar.bz2 android-node-v8-d16d9047eaa9f50d5dea5d7d42f6ae5b4369fe8b.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 951527ba4a..3711dd42a1 100644 --- a/doc/api/path.markdown +++ b/doc/api/path.markdown @@ -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 |