Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the overviewRulerColor setting to remove the outdated “empty string” disable approach and add clear guidance on using cSpell.showInRuler to disable the ruler. Key changes include:
- Added cross-references to the
cSpell.showInRulertoggle in JSDoc and schema files. - Removed instructions about disabling the color via an empty string.
- Synchronized descriptions in
package.jsonand multiple JSON schema sections.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/_server/src/config/cspellConfig/AppearanceSettings.mts | JSDoc: added note on disabling the ruler via showInRuler. |
| packages/_server/spell-checker-config.schema.json | JSON schema: updated overviewRulerColor descriptions to mention showInRuler. |
| package.json | JSON metadata: synchronized overviewRulerColor markdown entries. |
Comments suppressed due to low confidence (3)
packages/_server/spell-checker-config.schema.json:2665
- [nitpick] Add a blank line before “Disable the ruler...” to separate it as a new paragraph for better readability in the schema description.
"description": "The CSS color used to show issues in the ruler.\n\nDepends upon `#cSpell.useCustomDecorations#`. Disable the ruler by setting `#cSpell.showInRuler#` to `false`."
packages/_server/spell-checker-config.schema.json:2666
- [nitpick] Consider adding a blank line before “Disable the ruler...” in the markdownDescription to improve separation between paragraphs.
"markdownDescription": "The CSS color used to show issues in the ruler.\n\nDepends upon `#cSpell.useCustomDecorations#`.\nDisable the ruler by setting `#cSpell.showInRuler#` to `false`."
packages/_server/spell-checker-config.schema.json:2664
- The description for
overviewRulerColoris duplicated across several schema definitions; consider centralizing it in a shared constant or using a$refto reduce duplication and maintenance overhead.
"overviewRulerColor": {
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.
No description provided.