doc: path is ignored in url.format
authorMaurice Butler <maurice.butler@gmail.com>
Thu, 21 May 2015 04:00:16 +0000 (14:00 +1000)
committerRoman Reiss <me@silverwind.io>
Fri, 22 May 2015 12:58:32 +0000 (14:58 +0200)
Made it obvious that path is ignored in url.format

PR-URL: https://github.com/nodejs/io.js/pull/1753

doc/api/url.markdown

index 3931e8d..d2e9611 100644 (file)
@@ -85,6 +85,7 @@ Take a parsed URL object, and return a formatted URL string.
 Here's how the formatting process works:
 
 * `href` will be ignored.
+* `path` will be ignored.
 * `protocol` is treated the same with or without the trailing `:` (colon).
   * The protocols `http`, `https`, `ftp`, `gopher`, `file` will be
     postfixed with `://` (colon-slash-slash).