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>

diff --git a/doc/api/path.markdown b/doc/api/path.markdown
index 530dc440ca9f193dddf77a645dd2e53a97eb591a..e691d041458cc7ae3ac0f413b23625c13946522f 100644 (file)
--- 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