Skip to content

fix(oxfmt): Update wrong doc comment#17288

Merged
graphite-app[bot] merged 1 commit intomainfrom
12-23-fix_oxfmt_update_wrong_doc_comment
Dec 23, 2025
Merged

fix(oxfmt): Update wrong doc comment#17288
graphite-app[bot] merged 1 commit intomainfrom
12-23-fix_oxfmt_update_wrong_doc_comment

Conversation

@leaysgur
Copy link
Member

No description provided.

Copilot AI review requested due to automatic review settings December 23, 2025 00:41
@leaysgur leaysgur requested a review from Dunqing as a code owner December 23, 2025 00:41
@github-actions github-actions bot added A-formatter Area - Formatter C-bug Category - Bug labels Dec 23, 2025
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Contributor

Copilot AI left a comment

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 corrects the documentation comment for the embedded_language_formatting configuration option. The changes update both the description text and the default value from "auto" to "off", which accurately reflects the actual default implementation in the code.

  • Updated documentation text from "Control whether formats quoted code embedded in the file" to "Control whether formats embedded part in the file"
  • Corrected the default value from "auto" to "off" across all documentation locations

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
crates/oxc_formatter/src/oxfmtrc.rs Updated doc comment for embedded_language_formatting field with corrected description and default value
npm/oxfmt/configuration_schema.json Updated schema descriptions and markdown descriptions to match the corrected documentation
crates/oxc_formatter/tests/snapshots/schema_json.snap Updated snapshot test file to reflect the corrected schema descriptions
tasks/website_formatter/src/snapshots/schema_markdown.snap Updated markdown snapshot to reflect the corrected documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@leaysgur leaysgur force-pushed the 12-23-fix_oxfmt_update_wrong_doc_comment branch from fdd2cc8 to 2267ec5 Compare December 23, 2025 00:48
@Dunqing Dunqing added the 0-merge Merge with Graphite Merge Queue label Dec 23, 2025
Copy link
Member

Dunqing commented Dec 23, 2025

Merge activity

@graphite-app graphite-app bot force-pushed the 12-23-fix_oxfmt_update_wrong_doc_comment branch from 2267ec5 to 0a39cba Compare December 23, 2025 01:28
@graphite-app graphite-app bot merged commit 0a39cba into main Dec 23, 2025
20 checks passed
@graphite-app graphite-app bot deleted the 12-23-fix_oxfmt_update_wrong_doc_comment branch December 23, 2025 01:34
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-formatter Area - Formatter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants