From f4279346c368da4bca09385f773e8eed1d389e5e Mon Sep 17 00:00:00 2001
From: s100 <shughes1@uk.ibm.com>
Date: Mon, 18 Jan 2016 17:33:00 +0000
Subject: doc: Make "JSON" snippets valid JSON

Documentation for `package.json`
[states](https://docs.npmjs.com/files/package.json) that it "must be actual
JSON, not just a JavaScript object literal".

PR-URL: https://github.com/npm/npm/pull/11196
Credit: @s100
Reviewed-By: @iarna
---
 doc/cli/npm-update.md | 45 +++++++++++++++++++++++----------------------
 1 file changed, 23 insertions(+), 22 deletions(-)

(limited to 'doc')

diff --git a/doc/cli/npm-update.md b/doc/cli/npm-update.md
index f79752fae..0a7abd0ae 100644
--- a/doc/cli/npm-update.md
+++ b/doc/cli/npm-update.md
@@ -44,16 +44,17 @@ on dependencies, `dep1` (`dep2`, .. etc.).  The published versions of `dep1` are
 
 ```
 {
-  dist-tags: { latest: "1.2.2" },
-  versions: { "1.2.2",
-              "1.2.1",
-              "1.2.0",
-              "1.1.2",
-              "1.1.1",
-              "1.0.0",
-              "0.4.1",
-              "0.4.0",
-              "0.2.0"
+  "dist-tags": { "latest": "1.2.2" },
+  "versions": {
+    "1.2.2",
+    "1.2.1",
+    "1.2.0",
+    "1.1.2",
+    "1.1.1",
+    "1.0.0",
+    "0.4.1",
+    "0.4.0",
+    "0.2.0"
   }
 }
 ```
@@ -63,8 +64,8 @@ on dependencies, `dep1` (`dep2`, .. etc.).  The published versions of `dep1` are
 If `app`'s `package.json` contains:
 
 ```
-dependencies: {
-  dep1: "^1.1.1"
+"dependencies": {
+  "dep1": "^1.1.1"
 }
 ```
 
@@ -76,8 +77,8 @@ Then `npm update` will install `dep1@1.2.2`, because `1.2.2` is `latest` and
 However, if `app`'s `package.json` contains:
 
 ```
-dependencies: {
-  dep1: "~1.1.1"
+"dependencies": {
+  "dep1": "~1.1.1"
 }
 ```
 
@@ -91,8 +92,8 @@ which is `1.1.2`.
 Suppose `app` has a caret dependency on a version below `1.0.0`, for example:
 
 ```
-dependencies: {
-  dep1: "^0.2.0"
+"dependencies": {
+  "dep1": "^0.2.0"
 }
 ```
 
@@ -102,8 +103,8 @@ versions which satisfy `^0.2.0`.
 If the dependence were on `^0.4.0`:
 
 ```
-dependencies: {
-  dep1: "^0.4.0"
+"dependencies": {
+  "dep1": "^0.4.0"
 }
 ```
 
@@ -118,8 +119,8 @@ the minimum required dependency in `package.json`, you can use
 `package.json` contains:
 
 ```
-dependencies: {
-  dep1: "^1.1.1"
+"dependencies": {
+  "dep1": "^1.1.1"
 }
 ```
 
@@ -127,8 +128,8 @@ Then `npm update --save` will install `dep1@1.2.2` (i.e., `latest`),
 and `package.json` will be modified:
 
 ```
-dependencies: {
-  dep1: "^1.2.2"
+"dependencies": {
+  "dep1": "^1.2.2"
 }
 ```
 
-- 
cgit v1.2.3