Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(update): Replace comma with period in run on sentence #7142

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

DanKaplanSES
Copy link
Contributor

@DanKaplanSES DanKaplanSES commented Jan 16, 2024

  • I replaced a comma with period in run on sentence.

  • I also removed the word "direct" in the phrase "direct dependencies." To be honest, I'm not sure if this change was correct; I don't know what the differences between a "dependency" and a "direct dependency," and I'm hoping to learn through feedback on this PR.

    • If "direct" means "not transitive," I don't think any clarity is lost by my modification. I'd even argue this change adds clarity and may expose a missing detail: what happens to transitive dependencies when you npm update? Of course, that question is built on top of assumptions; I'm hoping that sharing what I was thinking at the time could help others in reviewing my change.

References

https://docs.npmjs.com/cli/v10/commands/npm-update

- I also removed the word "direct" in the phrase "direct dependencies." To be honest, I'm not sure if this change was correct; I don't know what the differences between a "dependency" and a "direct dependency," and I'm hoping to learn through feedback on this PR.

   - If "direct" means "not transitive," I don't think any clarity is lost by my modification. I'd even argue this change adds clarity and may expose a missing detail: what happens to transitive dependencies when you `npm update`? Of course, that question is built on top of assumptions; I'm hoping that sharing what I was thinking at the time could help others in reviewing my change.
@DanKaplanSES DanKaplanSES requested a review from a team as a code owner January 16, 2024 22:06
@ljharb
Copy link
Contributor

ljharb commented Jan 17, 2024

"direct" is indeed correct; something that is not direct is "transitive", meaning, it's not listed in package.json, and I think it's important to convey that it's only referring to listed deps.

@DanKaplanSES
Copy link
Contributor Author

"direct" is indeed correct; something that is not direct is "transitive", meaning, it's not listed in package.json, and I think it's important to convey that it's only referring to listed deps.

Because without the word "direct," users will think npm update inlines every transitive dependency within the package.json?

Since my original assumptions were correct, I'm also curious about this question: what happens to transitive dependencies when you npm update? I don't see the word "transitive" within this document.

@ljharb
Copy link
Contributor

ljharb commented Jan 17, 2024

I think the presence of the word causes zero harm if it's redundant, and prevents nonzero harm if it's not.

That's a good question - I'm relatively sure they're updated on disk, as if you rm -rf node_modules && npm installd.

@wraithgar wraithgar changed the title Replace comma with period in run on sentence docs(update): Replace comma with period in run on sentence Jan 19, 2024
@wraithgar wraithgar merged commit 67ab0f7 into npm:latest Jan 19, 2024
8 of 9 checks passed
@github-actions github-actions bot mentioned this pull request Jan 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants