doc: fix multiline return comments in querystring
authorClaudio Rodriguez <cjrodr@yahoo.com>
Mon, 14 Mar 2016 21:48:26 +0000 (18:48 -0300)
committerMyles Borins <mborins@us.ibm.com>
Wed, 30 Mar 2016 20:12:15 +0000 (13:12 -0700)
Changes the multiline return example commments in querystring
which have the example out-of-comment, into single comment
lines to remain consistent with other docs.

PR-URL: https://github.com/nodejs/node/pull/5705
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
doc/api/querystring.markdown

index 052bd0e..3a864e2 100644 (file)
@@ -28,15 +28,13 @@ Example:
 
 ```js
 querystring.parse('foo=bar&baz=qux&baz=quux&corge')
-// returns
-{ foo: 'bar', baz: ['qux', 'quux'], corge: '' }
+// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }
 
 // Suppose gbkDecodeURIComponent function already exists,
 // it can decode `gbk` encoding string
 querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
   { decodeURIComponent: gbkDecodeURIComponent })
-// returns
-{ w: '中文', foo: 'bar' }
+// returns { w: '中文', foo: 'bar' }
 ```
 
 ## querystring.stringify(obj[, sep][, eq][, options])
@@ -52,19 +50,16 @@ Example:
 
 ```js
 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })
-// returns
-'foo=bar&baz=qux&baz=quux&corge='
+// returns 'foo=bar&baz=qux&baz=quux&corge='
 
 querystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')
-// returns
-'foo:bar;baz:qux'
+// returns 'foo:bar;baz:qux'
 
 // Suppose gbkEncodeURIComponent function already exists,
 // it can encode string with `gbk` encoding
 querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
   { encodeURIComponent: gbkEncodeURIComponent })
-// returns
-'w=%D6%D0%CE%C4&foo=bar'
+// returns 'w=%D6%D0%CE%C4&foo=bar'
 ```
 
 ## querystring.unescape