doc: update url doc to account for escaping

Fixes: nodejs#2113 Ref: 17a379e PR-URL: nodejs#2605 Reviewed-By: jasnell - James M Snell <[email protected]> Reviewed-By: cjihrig - Colin Ihrig <[email protected]> Reviewed-By: mscdex - Brian White <[email protected]>
Fishrock123 · Sep 3, 2015 · 4b9e748 · 4b9e748
1 parent 84ac9cd
commit 4b9e748
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/doc/api/url.markdown b/doc/api/url.markdown
@@ -5,6 +5,8 @@
 This module has utilities for URL resolution and parsing.
 Call `require('url')` to use it.
 
+## URL Parsing
+
 Parsed URL objects have some or all of the following fields, depending on
 whether or not they exist in the URL string. Any parts that are not in the URL
 string will not be in the parsed object. Examples are shown for the URL
@@ -64,6 +66,15 @@ string will not be in the parsed object. Examples are shown for the URL
 
     Example: `'#hash'`
 
+### Escaped Characters
+
+Spaces (`' '`) and the following characters will be automatically escaped in the
+properties of URL objects:
+
+    < > " ` \r \n \t { } | \ ^ '
+
+---
+
 The following methods are provided by the URL module:
 
 ## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])