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: correct bundledDependencies -> bundleDependencies #5171

merged 1 commit into from Jul 20, 2022


Copy link

@nlf nlf commented Jul 14, 2022

arborist normalizes bundledDependencies to bundleDependencies, this change corrects the documentation to match that reality

closes #5167

arborist normalizes `bundledDependencies` to `bundleDependencies`, this change corrects the documentation to match that reality
@nlf nlf requested a review from a team as a code owner July 14, 2022 16:09
Copy link

ljharb commented Jul 14, 2022

seems strange to me; "bundled dependencies" is what they are, they're not "dependencies for a bundle"

Copy link
Contributor Author

nlf commented Jul 14, 2022

if you consider the package that is bundling the dependencies to be a "bundle" then they are bundle dependencies.

the main reason for correcting docs here is that arborist has been normalizing it the other way for a very long time, which means a whole lot of the packuments in the registry have been changed to bundleDependencies. changing it back to bundledDependencies is certainly possible, but making docs match reality is always the lowest risk approach to these things

Copy link

ljharb commented Jul 14, 2022

I agree this change makes the most sense, but I think arborist chose the wrong normalization.

@fritzy fritzy merged commit 8ab5fca into latest Jul 20, 2022
29 checks passed
@fritzy fritzy deleted the nlf/bundle-deps-docs branch July 20, 2022 18:33
@fritzy fritzy mentioned this pull request Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

[DOCS] Improve BundleDependencies
4 participants