doc: improve paragraph in esm.md #34064
Merged
Conversation
This file contains 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
nodejs-github-bot
added
doc
doc/api/esm.md
Outdated
Comment on lines
126
to
132
| A folder containing a `package.json` file, and all subfolders below that folder | ||
| down until the next folder containing another `package.json`, is considered a | ||
| _package scope_. The `"type"` field defines how `.js` files should be treated | ||
| within a particular `package.json` file’s package scope. Every package in a | ||
| until the next folder containing another `package.json`, are a | ||
| _package scope_. The `"type"` field defines how to treat `.js` files | ||
| within the package scope. Every package in a | ||
| project’s `node_modules` folder contains its own `package.json` file, so each | ||
| project’s dependencies have their own package scopes. A `package.json` lacking a | ||
| `"type"` field is treated as if it contained `"type": "commonjs"`. | ||
| project’s dependencies have their own package scopes. If a `package.json` file | ||
| does not have a `"type"` field, the default `"type"` is `"commonjs"`. |
There was a problem hiding this comment.
Any reason to not go the full 80 characters per line?
There was a problem hiding this comment.
Just to keep the diff clear. I can re-wrap to fill out the lines if that's preferred.
guybedford
approved these changes
Jun 26, 2020
aduh95
reviewed
Jun 26, 2020
doc/api/esm.md
Outdated
| project’s dependencies have their own package scopes. A `package.json` lacking a | ||
| `"type"` field is treated as if it contained `"type": "commonjs"`. | ||
| project’s dependencies have their own package scopes. If a `package.json` file | ||
| does not have a `"type"` field, the default `"type"` is `"commonjs"`. |
There was a problem hiding this comment.
Is it worth noting that invalid values are also interpreted as "commonjs"?
Suggested change
| does not have a `"type"` field, the default `"type"` is `"commonjs"`. | |
| does not have a `"type"` field or an invalid one, the default `"type"` is | |
| `"commonjs"`. |
There was a problem hiding this comment.
If that's the case, then that seems like a good addition. I'd prefer that be a different pull request so that this one is kept purely style and grammar.
lpinca
approved these changes
Jun 27, 2020
|
Landed in 95eecd5 |
MylesBorins
pushed a commit
that referenced
this pull request
Jul 14, 2020
Edit for clarity, correct tense, and brevity. PR-URL: #34064 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Jul 16, 2020
Edit for clarity, correct tense, and brevity. PR-URL: #34064 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Sep 22, 2020
Edit for clarity, correct tense, and brevity. PR-URL: #34064 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Edit for clarity, correct tense, and brevity.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes