docs: accurately describe install-links effect on relative paths

npm · Sep 29, 2022 · 14d0c7d · 14d0c7d
1 parent bc21552
commit 14d0c7d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -910,9 +910,9 @@ number, if not already set in package.json.
 * Default: true
 * Type: Boolean
 
-When set file: protocol dependencies that exist outside of the project root
-will be packed and installed as regular dependencies instead of creating a
-symlink. This option has no effect on workspaces.
+When set file: protocol dependencies will be packed and installed as regular
+dependencies instead of creating a symlink. This option has no effect on
+workspaces.
 
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->

diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -1072,9 +1072,9 @@ define('install-links', {
   default: true,
   type: Boolean,
   description: `
-    When set file: protocol dependencies that exist outside of the project root
-    will be packed and installed as regular dependencies instead of creating a
-    symlink. This option has no effect on workspaces.
+    When set file: protocol dependencies will be packed and installed as
+    regular dependencies instead of creating a symlink. This option has
+    no effect on workspaces.
   `,
   flatten,
 })

diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -981,9 +981,9 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for insta
 * Default: true
 * Type: Boolean
 
-When set file: protocol dependencies that exist outside of the project root
-will be packed and installed as regular dependencies instead of creating a
-symlink. This option has no effect on workspaces.
+When set file: protocol dependencies will be packed and installed as regular
+dependencies instead of creating a symlink. This option has no effect on
+workspaces.
 `
 
 exports[`test/lib/utils/config/definitions.js TAP > config description for json 1`] = `