From c682329c8ef04d111a6f9b690bb39a4a3b94f7d4 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 doc: limit path.format line to 80 characters doc: path.format remove the --- 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 f6df4cb58050c2..4bdf2e1565a196 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