Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: discuss special protocol handling #22261

Closed
wants to merge 2 commits into from
Closed

doc: discuss special protocol handling #22261

wants to merge 2 commits into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Aug 11, 2018

Fixes: #13523

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@jasnell jasnell added doc Issues and PRs related to the documentations. whatwg-url Issues and PRs related to the WHATWG URL implementation. fast-track PRs that do not need to wait for 48 hours to land. labels Aug 11, 2018
@nodejs-github-bot
Copy link
Collaborator

@jasnell build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/516/pipeline

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. url Issues and PRs related to the legacy built-in url module. labels Aug 11, 2018
@jasnell jasnell added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 11, 2018
@jasnell
Copy link
Member Author

jasnell commented Aug 11, 2018

Please 👍 to fast-track

Trott
Trott approved these changes Aug 11, 2018
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

Left some non-blocking nits.

doc/api/url.md Outdated
##### Special Schemes

The WHATWG URL Standard considers a handful of URL protocol schemes to be
"special" in terms of how those are parsed and serialized. When a URL is
Copy link
Member

Choose a reason for hiding this comment

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

  • Italics instead of quotes around special.
  • those -> they

doc/api/url.md Outdated
```

However, changing from `http` to a hypothetical `fish` protocol does not
because the new protocol is not considered "special".
Copy link
Member

Choose a reason for hiding this comment

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

  • No quotes around special.

doc/api/url.md Outdated
@@ -389,6 +389,46 @@ console.log(myURL.href);

Invalid URL protocol values assigned to the `protocol` property are ignored.

##### Special Schemes

The WHATWG URL Standard considers a handful of URL protocol schemes to be
Copy link
Member

Choose a reason for hiding this comment

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

Linking the text WHATWG URL Standard to the standard itself would be useful here. It's already linked in two other places in the doc, so it's just a matter of changing the markdown to [WHATWG URL Standard][].

@Trott
Copy link
Member

Trott commented Aug 11, 2018

(Intentionally not approving fast-tracking here. There's enough new material here that it's probably worth not rushing the review process IMO and I'm unaware of any reason to rush landing it. I won't block fast-tracking but I'd ask people to consider carefully if this really needs to be fast-tracked.)

@Trott
Copy link
Member

Trott commented Aug 11, 2018

@jasnell You added the author ready tag before there were any approvals. Please only add the author ready tag after there is at least one Collaborator approval.

@jasnell
Copy link
Member Author

jasnell commented Aug 11, 2018

Feel free to push your suggested edits to the PR.

@Trott
Copy link
Member

Trott commented Aug 11, 2018

Feel free to push your suggested edits to the PR.

👍 Done.

jasnell added a commit that referenced this pull request Aug 11, 2018
@jasnell
doc: discuss special protocol handling
58cf409 
Fixes: #13523

PR-URL: #22261
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
@jasnell
Copy link
Member Author

jasnell commented Aug 11, 2018

Landed in 58cf409 (fast tracked with approval)

@jasnell jasnell closed this Aug 11, 2018
@Trott Trott mentioned this pull request Aug 12, 2018
Closed
targos pushed a commit that referenced this pull request Aug 12, 2018
@jasnell @targos
doc: discuss special protocol handling
3814e46 
Fixes: #13523

PR-URL: #22261
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
@bengl bengl added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Aug 13, 2018
@bengl
Copy link
Member

bengl commented Aug 13, 2018

^ Accidental tag removal and addition. Sorry!

@rvagg rvagg mentioned this pull request Aug 13, 2018
Merged
This was referenced Aug 16, 2018
Closed
Closed
This was referenced Aug 16, 2018
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@maclover7 maclover7 maclover7 approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. url Issues and PRs related to the legacy built-in url module. whatwg-url Issues and PRs related to the WHATWG URL implementation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@jasnell @nodejs-github-bot @Trott @bengl @lpinca @maclover7 @vsemozhetbyt @trivikr