doc: explain path.format expected properties

eversojk · Myles Borins · commit 79d26ae19640 · 2016-03-30T13:12:16.000-07:00
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>
diff --git 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
