Skip to content

Conversation

@TimothyGu
Copy link
Member

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, url

@nodejs-github-botnodejs-github-bot added the tools Issues and PRs related to the tools directory. label Feb 13, 2017
@TimothyGuTimothyGu added doc Issues and PRs related to the documentations. whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Feb 13, 2017
doc/api/url.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably "as percent-encoded strings" or "as a string of percent-encoded characters", or even "percent-encoded bytes"? "a percent-encoded string" sounds a bit weird given that they would be not just be encoded but also joined with & and =s.

Another way to explain it would be to mention that it is somewhat similar to querystring.stringify().

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

-Returns the search parameters serialized as a URL-encoded string.+Returns the search parameters serialized as a string, with characters+percent-encoded where necessary.

doc/api/url.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "does not allow users to customize the.." seems easier to read?

doc/api/url.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Below it"?(as opposed to "Above it")

doc/api/url.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's already there but technically, doesn't url.parse() percent-decode things..?

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url.parse() also encodes certain things:

>url.parse('http://\n.com').pathname'%0A.com'

@jasnell
Copy link
Member

@TimothyGu
Copy link
MemberAuthor

Landed in 6cea5dd and bd07c8f.

@TimothyGuTimothyGu deleted the url-components-doc branch February 16, 2017 05:57
TimothyGu added a commit that referenced this pull request Feb 16, 2017
PR-URL: #11330 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
TimothyGu added a commit that referenced this pull request Feb 16, 2017
Also remove executable bit from doc/api/url.md's mode. PR-URL: #11330 Fixes: 4757ddc "doc: add basic documentation for WHATWG URL API" Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
TimothyGu added a commit to TimothyGu/node that referenced this pull request Feb 18, 2017
TimothyGu added a commit to TimothyGu/node that referenced this pull request Feb 18, 2017
Also remove executable bit from doc/api/url.md's mode. Backport-of: nodejs#11330 Fixes: 84e2ff3 "doc: add basic documentation for WHATWG URL API"
@TimothyGuTimothyGu mentioned this pull request Feb 18, 2017
4 tasks
italoacasas pushed a commit to italoacasas/node that referenced this pull request Feb 20, 2017
italoacasas pushed a commit to italoacasas/node that referenced this pull request Feb 20, 2017
Also remove executable bit from doc/api/url.md's mode. Backport-of: nodejs#11330 Fixes: 84e2ff3 "doc: add basic documentation for WHATWG URL API"
italoacasas pushed a commit that referenced this pull request Feb 22, 2017
italoacasas pushed a commit that referenced this pull request Feb 22, 2017
Also remove executable bit from doc/api/url.md's mode. Backport-of: #11330 Fixes: 84e2ff3 "doc: add basic documentation for WHATWG URL API"
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.toolsIssues and PRs related to the tools directory.whatwg-urlIssues and PRs related to the WHATWG URL implementation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@TimothyGu@jasnell@joyeecheung@italoacasas@nodejs-github-bot