doc: add node: prefix for all core modules#42752
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Collaborator
nodejs-github-bot commented Apr 15, 2022
Review requested:
|
aduh95force-pushed the node-prefix-in-docs branch from b926e8a to f3aff3eCompareSome core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced.
aduh95force-pushed the node-prefix-in-docs branch from f3aff3e to 3e71f33Compare
Member
targos commented Apr 16, 2022
This may be a good opportunity to introduce |
aduh95 added the author ready ContributorAuthor
aduh95 commented Apr 16, 2022
From what I can tell, it's not something I can do in this PR, but rather something that someone can do once it has landed, correct? |
Mesteery approved these changes Apr 16, 2022
RafaelGSS approved these changes Apr 16, 2022
VoltrexKeyva approved these changes Apr 16, 2022
Member
tniessen commented Apr 17, 2022
+1 to doing this in examples (or, more generally, in code). Not so sure about doing this in text. |
Member
targos commented Apr 18, 2022
Yeah, that's correct. |
GeoffreyBooth approved these changes Apr 19, 2022
aduh95 added the commit-queue 
Qard approved these changes Apr 20, 2022
nodejs-github-bot added commit-queue-failed Collaborator
nodejs-github-bot commented Apr 20, 2022
Commit Queue failed- Loading data for nodejs/node/pull/42752 ✔ Done loading data for nodejs/node/pull/42752 ----------------------------------- PR info ------------------------------------ Title doc: add `node:` prefix for all core modules (#42752) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch aduh95:node-prefix-in-docs -> nodejs:master Labels doc, author ready Commits 3 - doc: add `node:` prefix for all core modules - fixup! doc: add `node:` prefix for all core modules - fixup! doc: add `node:` prefix for all core modules Committers 1 - Antoine du Hamel PR-URL: https://github.com/nodejs/node/pull/42752 Fixes: https://github.com/nodejs/node/issues/38343 Reviewed-By: Matteo Collina Reviewed-By: Mestery Reviewed-By: Darshan Sen Reviewed-By: Akhil Marsonya Reviewed-By: Rafael Gonzaga Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: Geoffrey Booth Reviewed-By: Stephen Belanger ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/42752 Fixes: https://github.com/nodejs/node/issues/38343 Reviewed-By: Matteo Collina Reviewed-By: Mestery Reviewed-By: Darshan Sen Reviewed-By: Akhil Marsonya Reviewed-By: Rafael Gonzaga Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: Geoffrey Booth Reviewed-By: Stephen Belanger -------------------------------------------------------------------------------- ℹ This PR was created on Fri, 15 Apr 2022 23:24:08 GMT ✔ Approvals: 8 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/42752#pullrequestreview-943831582 ✔ - Mestery (@Mesteery): https://github.com/nodejs/node/pull/42752#pullrequestreview-943842190 ✔ - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/42752#pullrequestreview-943859669 ✔ - Akhil Marsonya (@marsonya): https://github.com/nodejs/node/pull/42752#pullrequestreview-943877375 ✔ - Rafael Gonzaga (@RafaelGSS): https://github.com/nodejs/node/pull/42752#pullrequestreview-943877842 ✔ - Mohammed Keyvanzadeh (@VoltrexMaster): https://github.com/nodejs/node/pull/42752#pullrequestreview-943881395 ✔ - Geoffrey Booth (@GeoffreyBooth): https://github.com/nodejs/node/pull/42752#pullrequestreview-946404778 ✔ - Stephen Belanger (@Qard): https://github.com/nodejs/node/pull/42752#pullrequestreview-946451455 ✔ Last GitHub CI successful ✖ No Jenkins CI runs detected -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/2192990918 |
ContributorAuthor
aduh95 commented Apr 20, 2022
Landed in 6afd3fc |
aduh95 added a commit to aduh95/node that referenced this pull request Apr 20, 2022
aduh95 added a commit that referenced this pull request Apr 20, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: nodejs#42752Fixes: nodejs#38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
Refs: nodejs#42752 PR-URL: nodejs#42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Apr 28, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
targos pushed a commit that referenced this pull request Apr 28, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
RaisinTen added a commit to RaisinTen/node that referenced this pull request May 9, 2022
This would make the GitHub blame UI ignore the revisions mentioned in the .git-blame-ignore-revs file. For now, it ignores the change introduced in nodejs@6afd3fc as asked for in nodejs#42752 (comment). Refs: https://github.blog/changelog/2022-03-24-ignore-commits-in-the-blame-view-beta Signed-off-by: Darshan Sen <[email protected]>
juanarbol pushed a commit that referenced this pull request May 31, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
juanarbol pushed a commit that referenced this pull request May 31, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
DeeDeeG added a commit to DeeDeeG/node that referenced this pull request Jul 11, 2022
Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: nodejs#35387 Refs: nodejs#37246 Refs: nodejs#42752
targos pushed a commit that referenced this pull request Jul 12, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jul 12, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
nodejs-github-bot pushed a commit that referenced this pull request Jul 14, 2022
Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: #35387 Refs: #37246 Refs: #42752 PR-URL: #43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
danielleadams pushed a commit that referenced this pull request Jul 26, 2022
Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: #35387 Refs: #37246 Refs: #42752 PR-URL: #43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
targos pushed a commit that referenced this pull request Jul 31, 2022
Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jul 31, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
targos pushed a commit that referenced this pull request Jul 31, 2022
Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: #35387 Refs: #37246 Refs: #42752 PR-URL: #43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
Refs: nodejs/node#42752 PR-URL: nodejs/node#42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: nodejs/node#42752Fixes: nodejs/node#38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: nodejs/node#35387 Refs: nodejs/node#37246 Refs: nodejs/node#42752 PR-URL: nodejs/node#43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
5 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
13 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some core modules can be loaded with or without the
node:prefix. Using the prefix disambiguates which specifiers refer to core modules.This commit updates the docs to use the prefix everywhere, for consistency.
Alternative to #38620.
Fixes: #38343