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: edit subpath export patterns introduction #35254

Merged
merged 1 commit into from Sep 21, 2020
Merged

doc: edit subpath export patterns introduction #35254

merged 1 commit into from Sep 21, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 18, 2020

  • Use parallel construction in the two sentences
  • Backticks around package.json to match rest of file
  • Add comma for readability
  • Own the recommendation ("we recommend")
Checklist

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/modules

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 18, 2020
mhdawson
mhdawson reviewed Sep 18, 2020
View reviewed changes
doc/api/packages.md
subpaths this can start to cause package.json bloat and maintenance issues.
For packages with a small number of exports, we recommend explicitly listing
each exports subpath entry. But for packages that have large numbers of
subpaths, this might cause `package.json` bloat and maintenance issues.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
subpaths, this might cause `package.json` bloat and maintenance issues.
this might cause `package.json` bloat and cause maintenance issues.

mhdawson
mhdawson approved these changes Sep 18, 2020
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

guybedford
guybedford approved these changes Sep 18, 2020
View reviewed changes
Copy link
Contributor

@guybedford guybedford left a comment

Choose a reason for hiding this comment

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

Thanks for taking a look at this.

@Trott
doc: edit subpath export patterns introduction
98768f3 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

PR-URL: nodejs#35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
@Trott Trott merged commit 98768f3 into nodejs:master Sep 21, 2020
@Trott
Copy link
Member Author

Trott commented Sep 21, 2020

Landed in 98768f3

@Trott Trott deleted the packages branch September 21, 2020 14:21
@ruyadorno
Copy link
Member

The doc/api/packages.md refactor has not yet landed on v14.x:

Until that's all resolved we should not land this patch on v14.x

MylesBorins pushed a commit that referenced this pull request Sep 24, 2020
@Trott @MylesBorins
doc: edit subpath export patterns introduction
d7282c0 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

PR-URL: #35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Sep 29, 2020
Merged
@aduh95 aduh95 mentioned this pull request Oct 23, 2020
Closed
3 tasks
aduh95 pushed a commit to aduh95/node that referenced this pull request Oct 23, 2020
@Trott @aduh95
doc: edit subpath export patterns introduction
55d15e6 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

PR-URL: nodejs#35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 3, 2020
@Trott @MylesBorins
doc: edit subpath export patterns introduction
e292b02 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

Backport-PR-URL: #35757
PR-URL: #35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Nov 3, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Nov 16, 2020
@Trott @MylesBorins
doc: edit subpath export patterns introduction
5f0b157 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

Backport-PR-URL: #35757
PR-URL: #35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@Trott @joesepi
doc: edit subpath export patterns introduction
4ae4ef4 
* Use parallel construction in the two sentences
* Backticks around _package.json_ to match rest of file
* Add comma for readability
* Own the recommendation ("we recommend")

PR-URL: nodejs#35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkrems jkrems jkrems approved these changes

@guybedford guybedford guybedford approved these changes

@mhdawson mhdawson mhdawson approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@Trott @nodejs-github-bot @ruyadorno @jkrems @guybedford @mhdawson @MylesBorins @aduh95