summaryrefslogtreecommitdiff
path: root/deps/npm/doc/api/bugs.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/api/bugs.md')
-rw-r--r--deps/npm/doc/api/bugs.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/deps/npm/doc/api/bugs.md b/deps/npm/doc/api/bugs.md
new file mode 100644
index 0000000000..cc4db8f9ec
--- /dev/null
+++ b/deps/npm/doc/api/bugs.md
@@ -0,0 +1,19 @@
+npm-bugs(3) -- Bugs for a package in a web browser maybe
+========================================================
+
+## SYNOPSIS
+
+ npm.commands.bugs(package, callback)
+
+## DESCRIPTION
+
+This command tries to guess at the likely location of a package's
+bug tracker URL, and then tries to open it using the `--browser`
+config param.
+
+Like other commands, the first parameter is an array. This command only
+uses the first element, which is expected to be a package name with an
+optional version number.
+
+This command will launch a browser, so this command may not be the most
+friendly for programmatic use.