Skip to content
This repository was archived by the owner on Aug 11, 2022. It is now read-only.

Commit 9fc0dc4

Browse files
davidgilbertsonzkat
authored andcommitted
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: #21019 Credit: @davidgilbertson Reviewed-By: @zkat
1 parent f5230c9 commit 9fc0dc4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/cli/npm-link.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,14 @@ above use-case in a shorter way:
5353
The second line is the equivalent of doing:
5454

5555
(cd ../node-redis; npm link)
56-
npm link node-redis
56+
npm link redis
5757

5858
That is, it first creates a global link, and then links the global
5959
installation target into your project's `node_modules` folder.
6060

61+
Note that in this case, you are referring to the directory name, `node-redis`,
62+
rather than the package name `redis`.
63+
6164
If your linked package is scoped (see `npm-scope(7)`) your link command must
6265
include that scope, e.g.
6366

0 commit comments

Comments
 (0)