From d16d9047eaa9f50d5dea5d7d42f6ae5b4369fe8b Mon Sep 17 00:00:00 2001 From: John Eversole Date: Sat, 19 Mar 2016 09:59:15 -0700 Subject: [PATCH] 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 Reviewed-By: Benjamin Gruenbaum --- doc/api/path.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/path.markdown b/doc/api/path.markdown index 951527ba4ab4cd..3711dd42a1279c 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