Skip to content

docs: update code examples for node:url module - #38645

Merged
aduh95 merged 1 commit into
nodejs:masterfrom
fisker:url-docs
May 19, 2021
Merged

docs: update code examples for node:url module#38645
aduh95 merged 1 commit into
nodejs:masterfrom
fisker:url-docs

Conversation

@fisker

@fiskerfisker commented May 12, 2021

Copy link
Copy Markdown
Contributor

There are many things called url in this page including url module,
URL instances, etc.

The original example was not clear where these methods come from.

@github-actionsgithub-actionsBot added doc Issues and PRs related to the documentations. url Issues and PRs related to the legacy built-in url module. labels May 12, 2021
@aduh95

aduh95 commented May 12, 2021

Copy link
Copy Markdown
Contributor

Thanks for sending this, I'm not sure we want to do that: it raises questions such as "Why go for require instead of import?" or "Should we include "use script"; in the code snippets?". The current code snippets are less rigorous as they couldn't run by themselves, but maybe that's OK for an example to leave out the boilerplate.

@fisker

fisker commented May 12, 2021

Copy link
Copy Markdown
ContributorAuthor

Why go for require instead of import?

Because all other codes use require in this file. (this can answer to other similar questions too)

@aduh95aduh95 mentioned this pull request May 12, 2021
Closed
@fisker

fisker commented May 19, 2021

Copy link
Copy Markdown
ContributorAuthor

// @aduh95 Added esm examples as request in #38651 (comment)

aduh95
aduh95 reviewed May 19, 2021
View reviewed changes

@aduh95aduh95 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few comments:

  • I feel it's more natural to use the named import for fileURLToPath instead of url.fileURLToPath, but I reckon it's a personal taste and I don't feel strongly about it.
  • I'm not sure we want to update the legacy section with ESM examples, this section of the docs is there for maintainers of legacy code base which would be written in CJS. wdyt?

Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
aduh95
aduh95 reviewed May 19, 2021
View reviewed changes
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
Comment threaddoc/api/url.md Outdated
@aduh95aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 19, 2021
@fisker@aduh95
doc: update code examples for node:url module
42cceff
There are many things called `url` in this page including `url` module,
`URL` instances, etc.
The original example was not clear where these methods come from.
PR-URL: #38645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@aduh95

aduh95 commented May 19, 2021

Copy link
Copy Markdown
Contributor

Landed in 42cceff, thanks for the contribution 🎉

@aduh95
aduh95 merged commit 42cceff into nodejs:masterMay 19, 2021
@fisker
fisker deleted the url-docs branch May 19, 2021 17:20
danielleadams pushed a commit that referenced this pull request May 31, 2021
@fisker@danielleadams
doc: update code examples for node:url module
5553be3
There are many things called `url` in this page including `url` module,
`URL` instances, etc.
The original example was not clear where these methods come from.
PR-URL: #38645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@danielleadamsdanielleadams mentioned this pull request May 31, 2021
Merged
richardlau pushed a commit that referenced this pull request Jul 16, 2021
@fisker@richardlau
doc: update code examples for node:url module
965d2b1
There are many things called `url` in this page including `url` module,
`URL` instances, etc.
The original example was not clear where these methods come from.
PR-URL: #38645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
richardlau pushed a commit that referenced this pull request Jul 19, 2021
@fisker@richardlau
doc: update code examples for node:url module
793c527
There are many things called `url` in this page including `url` module,
`URL` instances, etc.
The original example was not clear where these methods come from.
PR-URL: #38645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
richardlau pushed a commit that referenced this pull request Jul 20, 2021
@fisker@richardlau
doc: update code examples for node:url module
4d9129e
There are many things called `url` in this page including `url` module,
`URL` instances, etc.
The original example was not clear where these methods come from.
PR-URL: #38645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@richardlaurichardlau mentioned this pull request Jul 20, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@aduh95aduh95aduh95 approved these changes

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.urlIssues and PRs related to the legacy built-in url module.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@fisker@aduh95@jasnell