diff options
| author | David Gilbertson <gilbertson.david@gmail.com> | 2018-06-29 00:54:58 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@zkat.tech> | 2018-06-29 00:54:57 +0300 |
| commit | 9fc0dc4f58d728bac6a8db7143d04863d7b653db (patch) | |
| tree | a6dbff6048430ed05ec71fe9ef7b56087b8eb878 /doc | |
| parent | f5230c90afef40f445bf148cbb16d6129a2dcc19 (diff) | |
docs: clarify text in npm-link.md (#21019)
I wasn't clear on the exact behaviour with the shorthand, but I think this change is correct.
PR-URL: https://github.com/npm/npm/pull/21019
Credit: @davidgilbertson
Reviewed-By: @zkat
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-link.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/cli/npm-link.md b/doc/cli/npm-link.md index 7ba228525..3f6dc6e5b 100644 --- a/doc/cli/npm-link.md +++ b/doc/cli/npm-link.md @@ -53,11 +53,14 @@ above use-case in a shorter way: The second line is the equivalent of doing: (cd ../node-redis; npm link) - npm link node-redis + npm link redis That is, it first creates a global link, and then links the global installation target into your project's `node_modules` folder. +Note that in this case, you are referring to the directory name, `node-redis`, +rather than the package name `redis`. + If your linked package is scoped (see `npm-scope(7)`) your link command must include that scope, e.g. |