Skip to content
This repository was archived by the owner on Feb 18, 2021. It is now read-only.

Commit 29c8593

Browse files
committed
fix documentation / oxford comma
1 parent 1915eb5 commit 29c8593

File tree

3 files changed

+8
-13
lines changed

3 files changed

+8
-13
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,9 @@ Options:
198198

199199
#### `npm-shrinkwrap check`
200200

201-
Asserts that your `npm-shrinkwrap.json` file and node_modules
202-
directory are in sync. If any excess modules are in your
203-
node_modules folder, `check` will return an error and print
204-
a list of the excess dependencies that are installed.
201+
Asserts that your `npm-shrinkwrap.json` file, `package.json` file,
202+
and node_modules directory are in sync. If any inconsistency
203+
is found, an error is returned.
205204

206205
Options:
207206
--dirname sets the directory of the npm-shrinkwrap.json

bin/cli.js

+2-5
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,8 @@ function main(opts, callback) {
7575
'into node_modules');
7676
});
7777
} else if (command === 'check') {
78-
// Otherwise, we check to see if any erroneous dependencies are
79-
// installed.
80-
//
8178
// We set opts.dry to true, which suppresses all side effects in the
82-
// shrinkShrinkwrap routine.
79+
// syncShrinkwrap routine.
8380
opts.dry = true;
8481

8582
return syncShrinkwrap(opts, function (err, errorReport) {
@@ -119,7 +116,7 @@ function main(opts, callback) {
119116
}
120117

121118
console.log('npm-shrinkwrap.json is in sync ' +
122-
'with package.json');
119+
'with package.json and node_modules');
123120
});
124121
}
125122

bin/usage.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ Options:
3636

3737
## `{cmd} check`
3838

39-
Asserts that your `npm-shrinkwrap.json` file and node_modules
40-
directory are in sync. If any excess modules are in your
41-
node_modules folder, `check` will return an error and print
42-
a list of the excess dependencies that are installed.
39+
Asserts that your `npm-shrinkwrap.json` file, `package.json` file,
40+
and node_modules directory are in sync. If any inconsistency
41+
is found, an error is returned.
4342

4443
Options:
4544
--dirname sets the directory of the npm-shrinkwrap.json

0 commit comments

Comments
 (0)