refactor(plugin-sass-palette): correct docs and improve jsdoc #498
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Pull Request Test Coverage Report for Build 15426752731Details
💛 - Coveralls |
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation and JSDoc comments for the Sass Palette plugin while ensuring consistency in plugin name usage. Key changes include:
- Updating various JSDoc comments and examples in the source files to improve clarity and accuracy.
- Refactoring plugin name comparisons to use the PLUGIN_NAME constant for consistency.
- Revising documentation in both Chinese and English files to correct defaults and clarify instructions.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/development/plugin-sass-palette/src/node/useSassPalettePlugin.ts | Added improved JSDoc comments and replaced inline string with PLUGIN_NAME in filter logic. |
| plugins/development/plugin-sass-palette/src/node/sassPalettePlugin.ts | Enhanced JSDoc documentation with examples and bilingual comments. |
| plugins/development/plugin-sass-palette/src/node/removePalettePlugin.ts | Updated filter logic to use PLUGIN_NAME instead of a hard-coded string for consistency. |
| plugins/development/plugin-sass-palette/src/node/options.ts | Revised JSDoc comments for the various options to improve clarity and bilingual consistency. |
| plugins/development/plugin-sass-palette/src/node/injectScssConfigModule.ts | Expanded the function documentation to better describe the injection of SCSS config and palette modules. |
| docs/zh/plugins/development/sass-palette/guide.md | Corrected module naming and improved wording for clarity in the guide documentation. |
| docs/zh/plugins/development/sass-palette/config.md | Updated default value descriptions and language for enhanced clarity in configuration docs. |
| docs/zh/plugins/development/sass-palette/README.md | Corrected the import to use the scoped package name. |
| docs/plugins/development/sass-palette/guide.md | Refined wording and improved consistency between singular and plural mentions of themes. |
| docs/plugins/development/sass-palette/config.md | Made minor language improvements to the option descriptions and default values. |
| docs/plugins/development/sass-palette/README.md | Updated the import path to the correct package name. |
Mister-Hope
changed the title
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.
No description provided.