diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-09-18 12:48:37 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-09-21 17:20:31 +0300 |
| commit | 98768f3b5b9db2cb384e67acd96713a6ac931df7 (patch) | |
| tree | 49d561ecc051b41d319509a36e3ac01d8a976713 /doc/api/packages.md | |
| parent | 9c62e0e384e2ea5a45a4011f31c97be60f2a0737 (diff) | |
doc: edit subpath export patterns introduction
* 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: https://github.com/nodejs/node/pull/35254
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Diffstat (limited to 'doc/api/packages.md')
| -rw-r--r-- | doc/api/packages.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/packages.md b/doc/api/packages.md index 8cf2397279c..997ffae76a5 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -258,9 +258,9 @@ import submodule from 'es-module-package/private-module.js'; > Stability: 1 - Experimental -Explicitly listing each exports subpath entry is recommended for packages with -a small number of exports. But for packages that have very large numbers of -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. For these use cases, subpath export patterns can be used instead: |