Skip to content

Commit

Permalink
doc: edit subpath export patterns introduction
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
Trott authored and aduh95 committed Oct 23, 2020
1 parent 7b76e75 commit 55d15e6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/packages.md
Expand Up @@ -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:

Expand Down

0 comments on commit 55d15e6

Please sign in to comment.