Skip to content

fix: Update overviewRulerColor docs#4468

Merged
Jason3S merged 1 commit into
mainfrom
dev-doc
May 28, 2025
Merged

fix: Update overviewRulerColor docs#4468
Jason3S merged 1 commit into
mainfrom
dev-doc

Conversation

@Jason3S

@Jason3S Jason3S commented May 28, 2025

Copy link
Copy Markdown
Collaborator

No description provided.

@Jason3S Jason3S requested a review from Copilot May 28, 2025 16:42

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.showInRuler toggle in JSDoc and schema files.
  • Removed instructions about disabling the color via an empty string.
  • Synchronized descriptions in package.json and 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 overviewRulerColor is duplicated across several schema definitions; consider centralizing it in a shared constant or using a $ref to reduce duplication and maintenance overhead.
"overviewRulerColor": {

Comment thread packages/_server/src/config/cspellConfig/AppearanceSettings.mts
@Jason3S Jason3S merged commit 2865fd7 into main May 28, 2025
16 checks passed
@Jason3S Jason3S deleted the dev-doc branch May 28, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants