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.

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

doc: document self-referencing a package name #31680

Closed
wants to merge 1 commit into from

Conversation

giltayar
Copy link
Contributor

@giltayar giltayar commented Feb 7, 2020

Added a section for "Self-referencing a package using its name" that documents
importing a package's own exports (this was missed when adding the feature).

Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation. labels Feb 7, 2020
Copy link
Contributor

@jkrems jkrems 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 adding this! Looks good, one thing that may be confusing.

doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
@jkrems
Copy link
Contributor

jkrems commented Feb 7, 2020

/cc @nodejs/modules-active-members

Copy link
Contributor

@MylesBorins MylesBorins left a comment

Choose a reason for hiding this comment

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

LGTM

doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
@giltayar
Copy link
Contributor Author

giltayar commented Feb 9, 2020

Not sure about the protocol, and there's nothing in the guidelines about this: should I squash the commits?

@GeoffreyBooth
Copy link
Member

Not sure about the protocol, and there's nothing in the guidelines about this: should I squash the commits?

Yes, I think this PR would be appropriate for squashing. The commit message should follow the guidelines, such as starting with module: doc:.

@giltayar
Copy link
Contributor Author

Rebased and squashed.

doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
Added a section for "Self-referencing a package using its name" that documents
importing a package's own exports (this was missed when adding the feature).
@jkrems jkrems added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 2, 2020
@jkrems
Copy link
Contributor

jkrems commented Mar 2, 2020

Sorry for losing track of this. I assume this is good to land. I plan to do it at some point this week if nobody else beats me to it.

@addaleax
Copy link
Member

addaleax commented Mar 9, 2020

Landed in 9dbe6ab

@addaleax addaleax closed this Mar 9, 2020
addaleax pushed a commit that referenced this pull request Mar 9, 2020
Added a section for "Self-referencing a package using its name" that
documents importing a package's own exports (this was missed when
adding the feature).

PR-URL: #31680
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2020
Added a section for "Self-referencing a package using its name" that
documents importing a package's own exports (this was missed when
adding the feature).

PR-URL: #31680
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
@MylesBorins MylesBorins mentioned this pull request Mar 10, 2020
codebytere pushed a commit that referenced this pull request Mar 17, 2020
Added a section for "Self-referencing a package using its name" that
documents importing a package's own exports (this was missed when
adding the feature).

PR-URL: #31680
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
@codebytere codebytere mentioned this pull request Mar 17, 2020
codebytere pushed a commit that referenced this pull request Mar 23, 2020
Added a section for "Self-referencing a package using its name" that
documents importing a package's own exports (this was missed when
adding the feature).

PR-URL: #31680
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
codebytere pushed a commit that referenced this pull request Mar 30, 2020
Added a section for "Self-referencing a package using its name" that
documents importing a package's own exports (this was missed when
adding the feature).

PR-URL: #31680
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. esm Issues and PRs related to the ECMAScript Modules implementation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants