From 929b5b92a505436c82ea84d1c0097f6b58ae1a9e Mon Sep 17 00:00:00 2001 From: Claudio Rodriguez Date: Mon, 14 Mar 2016 18:48:26 -0300 Subject: [PATCH] doc: fix multiline return comments in querystring 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 Reviewed-By: Rich Trott Reviewed-By: Sakthipriyan Vairamani --- doc/api/querystring.markdown | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/doc/api/querystring.markdown b/doc/api/querystring.markdown index 052bd0ea41..3a864e2d4f 100644 --- a/doc/api/querystring.markdown +++ b/doc/api/querystring.markdown @@ -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