doc: add URL.format() example by zeke · Pull Request #18888 · nodejs/node

zeke · 2018-02-20T20:12:28Z

This PR adds an example use of the URL.format() method.

Resolves #18887

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc
url

Trott · 2018-02-20T20:18:31Z

doc/api/url.md

+Example:
+
+```js
+const URL = require('url');


Although it appears in other examples in this doc, I think in general we tend to leave out the require() for the module. I'm fine either way.

Oh! But we do use url and reserve URL for the newer url.URL. So maybe remove it and use url rather than URL below.

addaleax

LGTM with @Trott’s suggestion, in particular because URL is now available with that name on the global object :)

Trott · 2018-02-20T20:27:18Z

LGTM once we get the URL/url stuff sorted out.

zeke · 2018-02-20T20:51:13Z

Took out the require and changed URL to url to avoid new API / old API confusion. Thanks for the quick feedback!

Trott · 2018-02-20T21:55:22Z

doc/api/url.md

 The `url.format()` method returns a formatted URL string derived from
 `urlObject`.

+Example:


Nit: You can remove Example: too. It's obvious that it is an example.

BridgeAR

LGTM but I think it would be good to switch to "Prints".

BridgeAR · 2018-02-21T00:41:46Z

doc/api/url.md

+  }
+});
+
+// => 'https://example.com/some/path?page=1&format=json'


Other places in the file use Prints or just show the output below. I personally think a "Prints" would be better than =>.

I did a search in the docs and found several instances of // => symbolizing a returned value. Also, this method doesn't actually print a value, it just returns it.

I would be open to just doing // https://.... That was another "convention" I found when looking at existing code examples in Node's docs.

In this case I only spoke about this specific document. And yes, // => is still used some times but it is not really common as far as I know.

So I personally would say using // 'https:... would be good.

vsemozhetbyt · 2018-02-21T02:51:29Z

doc/api/url.md

+```js
+url.format({
+  protocol: 'https',
+  hostname: `example.com`,


Are the backticks intended? If so, are not they a bit confusing here? With them, a template literal/a tag function/other quotes inside are usually expected.

Good catch, @vsemozhetbyt. Backticks were not intentional there. Fixed.

tniessen · 2018-03-04T11:30:25Z

Lite-CI: https://ci.nodejs.org/job/node-test-pull-request-lite/212/

apapirovski · 2018-03-04T11:48:33Z

Landed in 1572a5b

PR-URL: #18888 Fixes: #18887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

PR-URL: nodejs#18888 Fixes: nodejs#18887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Backport-PR-URL: #22380 PR-URL: #18888 Fixes: #18887 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

doc: add URL.format() example

f86aef1

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 Feb 20, 2018

zeke changed the title ~~docs: add URL.format() example~~ doc: add URL.format() example Feb 20, 2018

Trott reviewed Feb 20, 2018

View reviewed changes

addaleax approved these changes Feb 20, 2018

View reviewed changes

iwko approved these changes Feb 20, 2018

View reviewed changes

doc: use lowercase url in url.format example

72f731e

lpinca approved these changes Feb 20, 2018

View reviewed changes

Trott reviewed Feb 20, 2018

View reviewed changes

Trott approved these changes Feb 20, 2018

View reviewed changes

doc: remove superfluous annotation of example code

084eb14

BridgeAR approved these changes Feb 21, 2018

View reviewed changes

vsemozhetbyt reviewed Feb 21, 2018

View reviewed changes

vsemozhetbyt approved these changes Feb 21, 2018

View reviewed changes

doc: change backticks to single quotes

0323617

cjihrig approved these changes Feb 21, 2018

View reviewed changes

silverwind approved these changes Feb 22, 2018

View reviewed changes

watilde approved these changes Feb 22, 2018

View reviewed changes

tniessen approved these changes Feb 23, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 2, 2018

tniessen removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 4, 2018

tniessen added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 4, 2018

apapirovski closed this Mar 4, 2018

zeke deleted the add-url-format-example-to-docs branch March 4, 2018 20:29

MylesBorins mentioned this pull request Mar 6, 2018

v9.8.0 proposal #19181

Merged

MylesBorins mentioned this pull request Sep 6, 2018

v8.12.0 proposal #21593

Merged

Uh oh!

Conversation

zeke commented Feb 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Feb 20, 2018

Uh oh!

zeke commented Feb 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeke Feb 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tniessen commented Mar 4, 2018

Uh oh!

apapirovski commented Mar 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

zeke commented Feb 20, 2018 •

edited

Loading

zeke Feb 21, 2018 •

edited

Loading