diff options
| author | Nikki Everett <neverett@users.noreply.github.com> | 2018-11-26 19:24:48 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@zkat.tech> | 2018-11-26 19:24:48 +0300 |
| commit | 6cc70cc1977e58a3e1ea48e660ffc6b46b390e59 (patch) | |
| tree | e9438f7de1842a886d51a12a3f0ed9d305c810cd /doc | |
| parent | 1b2fabccede37242233755961434c52536224de5 (diff) | |
docs: Add semver link and note on empty string format to `deprecate` doc (#68)
PR-URL: https://github.com/npm/cli/pull/68
Credit: @neverett
Reviewed-By: @zkat
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-deprecate.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/cli/npm-deprecate.md b/doc/cli/npm-deprecate.md index 1be6f491b..3660f49ab 100644 --- a/doc/cli/npm-deprecate.md +++ b/doc/cli/npm-deprecate.md @@ -10,15 +10,17 @@ npm-deprecate(1) -- Deprecate a version of a package This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it. -It works on version ranges as well as specific versions, so you can do -something like this: +It works on [version ranges](https://semver.npmjs.com/) as well as specific +versions, so you can do something like this: npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3" Note that you must be the package owner to deprecate something. See the `owner` and `adduser` help topics. -To un-deprecate a package, specify an empty string (`""`) for the `message` argument. +To un-deprecate a package, specify an empty string (`""`) for the `message` +argument. Note that you must use double quotes with no space between them to +format an empty string. ## SEE ALSO |