fix(docs): clean up npm stop docs

wraithgar · wraithgar · commit 307b3bd9f90e · 2021-01-14T13:16:15.000-08:00
Adds an example and outlines differences with `npm start` PR-URL: #2460 Credit: @wraithgar Close: #2460 Reviewed-by: @darcyclarke
diff --git a/docs/content/commands/npm-stop.md b/docs/content/commands/npm-stop.md
@@ -12,7 +12,31 @@ npm stop [-- <args>]
 
 ### Description
 
-This runs a package's "stop" script, if one was provided.
+This runs a predefined command specified in the "stop" property of a
+package's "scripts" object.
+
+Unlike with [npm start](/commands/npm-start), there is no default script
+that will run if the `"stop"` property is not defined.
+
+### Example
+
+```json
+{
+  "scripts": {
+    "stop": "node bar.js"
+  }
+}
+```
+
+```bash
+npm stop
+
+> npm@x.x.x stop
+> node bar.js
+
+(bar.js output would be here)
+
+```
 
 ### See Also
 
