docs: remove obsolete comments from config examples #12526
Merged
Conversation
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
✅ Deploy Preview for rspack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes redundant // ... comments from configuration examples across documentation files in both English and Chinese versions. These comments were used to indicate omitted code but don't provide meaningful value and can be visually distracting.
- Removes
// ...comments from configuration object examples - Affects documentation files for plugins, guides, configuration options, and blog posts
- Improves clarity and focus of code examples
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/plugins/webpack/source-map-dev-tool-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/zh/plugins/webpack/eval-source-map-dev-tool-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/zh/plugins/rspack/swc-js-minimizer-rspack-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/zh/plugins/rspack/lightning-css-minimizer-rspack-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/zh/plugins/rspack/html-rspack-plugin.mdx | Removed // ... comments from multiple configuration examples |
| website/docs/zh/guide/tech/vue.mdx | Removed // ... comments from configuration and rules examples |
| website/docs/zh/guide/tech/react.mdx | Removed // ... comment from configuration example |
| website/docs/zh/guide/tech/preact.mdx | Removed // ... comment from configuration example |
| website/docs/zh/guide/optimization/use-rsdoctor.mdx | Removed // ... comment from configuration example |
| website/docs/zh/guide/features/builtin-swc-loader.mdx | Removed // ... comments from multiple options examples |
| website/docs/zh/config/watch.mdx | Removed // ... comments from watch configuration examples |
| website/docs/zh/config/target.mdx | Removed // ... comments from target configuration examples |
| website/docs/zh/config/stats.mdx | Removed // ... comment from stats configuration example |
| website/docs/zh/config/resolve.mdx | Removed // ... comments from resolve configuration examples |
| website/docs/zh/config/output.mdx | Removed // ... comment from output configuration example |
| website/docs/zh/config/other-options.mdx | Removed // ... comment from loader configuration example |
| website/docs/zh/config/module-rules.mdx | Removed // ... comments from multiple module rules examples |
| website/docs/zh/config/externals.mdx | Removed // ... comments from multiple externals configuration examples |
| website/docs/zh/config/dev-server.mdx | Removed // ... comments from dev server configuration examples |
| website/docs/zh/blog/announcing-1-3.mdx | Removed // ... comment from buildHttp configuration example |
| website/docs/zh/blog/announcing-0-6.mdx | Removed // ... comment from diff example |
| website/docs/zh/blog/announcing-0-5.mdx | Removed // ... comments from diff examples |
| website/docs/zh/blog/announcing-0-4.mdx | Removed // ... comment from configuration example |
| website/docs/zh/api/plugin-api/runtime-plugin-hooks.mdx | Removed // ... comment from plugin configuration example |
| website/docs/en/plugins/webpack/source-map-dev-tool-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/en/plugins/webpack/eval-source-map-dev-tool-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/en/plugins/rspack/swc-js-minimizer-rspack-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/en/plugins/rspack/lightning-css-minimizer-rspack-plugin.mdx | Removed // ... comment from configuration example |
| website/docs/en/guide/tech/vue.mdx | Removed // ... comments from configuration and rules examples |
| website/docs/en/guide/tech/react.mdx | Removed // ... comment from configuration example |
| website/docs/en/guide/tech/preact.mdx | Removed // ... comment from configuration example |
| website/docs/en/guide/optimization/use-rsdoctor.mdx | Removed // ... comment from configuration example |
| website/docs/en/guide/features/builtin-swc-loader.mdx | Removed // ... comments from multiple options examples |
| website/docs/en/config/watch.mdx | Removed // ... comments from watch configuration examples |
| website/docs/en/config/target.mdx | Removed // ... comments from target configuration examples |
| website/docs/en/config/stats.mdx | Removed // ... comment from stats configuration example |
| website/docs/en/config/resolve.mdx | Removed // ... comments from resolve configuration examples |
| website/docs/en/config/output.mdx | Removed // ... comment from output configuration example |
| website/docs/en/config/other-options.mdx | Removed // ... comment from loader configuration example |
| website/docs/en/config/module-rules.mdx | Removed // ... comments from multiple module rules examples |
| website/docs/en/config/externals.mdx | Removed // ... comments from multiple externals configuration examples |
| website/docs/en/config/dev-server.mdx | Removed // ... comments from dev server configuration examples |
| website/docs/en/blog/announcing-1-3.mdx | Removed // ... comment from buildHttp configuration example |
| website/docs/en/blog/announcing-0-6.mdx | Removed // ... comment from diff example |
| website/docs/en/blog/announcing-0-5.mdx | Removed // ... comments from diff examples |
| website/docs/en/blog/announcing-0-4.mdx | Removed // ... comment from configuration example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
This PR removes redundant
// ...comments from configuration examples in the documentation.These comments do not add meaningful information and can be visually distracting or misleading. Readers already understand that documentation snippets are partial and focused on the option being described.
By removing them, the examples become cleane and more focused.
Checklist