diff options
author | Forrest L Norvell <forrest@npmjs.com> | 2015-08-15 04:21:13 +0300 |
---|---|---|
committer | Forrest L Norvell <forrest@npmjs.com> | 2015-09-09 02:48:11 +0300 |
commit | 2fb60bfef323d8dcf8f8c972bcb8e4d167e5e25d (patch) | |
tree | 39a5f18a3e2705a899c914e8c1e40a627a4eb40e /doc/api/npm-unpublish.md | |
parent | b064c40b16c2c2c318ada2f502069002ba074e2c (diff) |
doc: remove misleading API documentation
The API is awkward, brittle, and frequently counterintuitive. Having it
documented sets an unrealistic expectation of it being a supported /
encouraged thing for developers outside the team to use. Until we have
an API we should stand behind, having it be undocumented is actually a
net win because people won't be misled into thinking they're gonna have
a good time by using it.
Diffstat (limited to 'doc/api/npm-unpublish.md')
-rw-r--r-- | doc/api/npm-unpublish.md | 20 |
1 files changed, 0 insertions, 20 deletions
diff --git a/doc/api/npm-unpublish.md b/doc/api/npm-unpublish.md deleted file mode 100644 index 6cbc5c1f3..000000000 --- a/doc/api/npm-unpublish.md +++ /dev/null @@ -1,20 +0,0 @@ -npm-unpublish(3) -- Remove a package from the registry -====================================================== - -## SYNOPSIS - - npm.commands.unpublish(package, callback) - -## DESCRIPTION - -This removes a package version from the registry, deleting its -entry and removing the tarball. - -The package parameter must be defined. - -Only the first element in the package parameter is used. If there is no first -element, then npm assumes that the package at the current working directory -is what is meant. - -If no version is specified, or if all versions are removed then -the root package entry is removed from the registry entirely. |