docs: Remove ", instead of updating the package lock"

[DanKaplanSES]

Remove ", instead of updating the package lock" from the docs because, AFAIK, that never occurs anyway. The last bullet point states this, too.

References

[wraithgar]

This is referring to the fact that npm install would update the package-lock to match in that case, which npm ci will not do.

[DanKaplanSES]

@wraithgar Clarifying question: Are you saying the phrase should remain in the docs?

[wraithgar]

Yes I think it should.

[DanKaplanSES]

Yes I think it should.

I see. I'm not following how would a reader could know that phrase is referring to npm install. If you have the time, could you walk me through that?

[reggi]

@DanKaplanSES a reader would know that phrase is referring to npm install because the file starts off with:

This command is similar to npm install, except...

And lists the differences between the two commands.

[DanKaplanSES]

Okay, I understand the thought process, but:

If dependencies in the package lock do not match those in package.json, npm ci will exit with an error, instead of updating the package lock.

can also be misinterpreted as:

If dependencies in the package lock do not match those in package.json, npm ci will exit with an error, instead of [npm ci] updating the package lock.

One way to prevent that misinterpretation is to remove the phrase entirely, but there are other ways, such as:

If dependencies in the package lock do not match those in package.json, npm ci will exit with an error, whereas npm install would update the package lock file.

I'm not tied to my edit, but IMO, it should be edited in some way because it can be misinterpreted, and there are easy ways to prevent the possibility.

[reggi]

Sorry I posted a message then deleted it. I think this is fine as it is theres also a heading for the list which offers further context for the sentence.

The main differences between using npm install and npm ci are:

[DanKaplanSES]

Sorry I posted a message then deleted it. I think this is fine as it is theres also a heading for the list which offers further context for the sentence.

The main differences between using npm install and npm ci are:

Hi @reggi I'm not sure I fully understand your point of view yet. Would it be misrepresenting your position if I reworded your statement like this: "This is fine because it can be interpreted correctly"?

[reggi]

@DanKaplanSES I think this is fine because it can be interpreted correctly. This is a page for npm ci command and the list is of differences between these two commands.

The main differences between using npm install and npm ci are:

* The project must have an existing package-lock.json or npm-shrinkwrap.json.
* If dependencies in the package lock do not match those in package.json, npm ci will exit with an error, instead of updating the package lock.
* npm ci can only install entire projects at a time: individual dependencies cannot be added with this command.
* If a node_modules is already present, it will be automatically removed before npm ci begins its install.
* It will never write to package.json or any of the package-locks: installs are essentially frozen.

If I were to have a document about bananas

The main differences between apples and bananas are:

 * bananas are yellow, instead of being red

I don't think it's super ambiguous what "red" is referring to.

I think this is grammatically and colloquially ok to leave it as it is.