docs: improve readability of optimization.chunkIds documentation#8068
Open
Raginipatel17 wants to merge 3 commits intowebpack:mainfrom
Open
docs: improve readability of optimization.chunkIds documentation#8068Raginipatel17 wants to merge 3 commits intowebpack:mainfrom
Raginipatel17 wants to merge 3 commits intowebpack:mainfrom
Conversation
Ref: webpack#6356 (related) ### Summary This PR improves the readability of the `optimization.chunkIds` section by simplifying how types are described and making the default behavior easier to understand. ### Type of change - Documentation enhancement ### Testing - Not applicable (documentation-only change) ### Breaking changes - None
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| ## optimization.chunkIds | ||
|
|
||
| `boolean = false` `string: 'natural' | 'named' | 'size' | 'total-size' | 'deterministic'` | ||
| Type: boolean | string |
Member
There was a problem hiding this comment.
Please don't change type, because string is wrong type here
Fix incorrect `string` type for `optimization.chunkIds` and document allowed values explicitly.
Contributor
Author
|
Thanks for pointing that out! Updated the type to use the correct allowed values. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ref: #6356 (related)
Summary
Improved the documentation of
optimization.chunkIdsby making type definitions clearer and presenting default values in a more readable way.What kind of change does this PR introduce?
Documentation update.
Did you add tests for your changes?
No
Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged, or what have you already documented?
The
optimization.chunkIdssection has been updated to improve clarity for users.Use of AI
Used AI assistance to help refine the wording.