From e80cbab93f0b30ce6619f9b37636410bc8caab5d Mon Sep 17 00:00:00 2001 From: Roman Zipp Date: Wed, 2 Oct 2024 13:03:23 +0200 Subject: [PATCH] Fix docs `format_on_save` value is not a boolean (#18619) Fixed [Configuring Languages](https://zed.dev/docs/configuring-languages) docs using boolean value for `format_on_save` option although it accepts string values of `"on"` or `"off"` Details: The documentation on [configuring languages](https://zed.dev/docs/configuring-languages) states the use of boolean values for the `format_on_save` option although the [configuration reference](https://zed.dev/docs/configuring-zed#format-on-save) only allows the usage of string values `"on"` or `"off"`. In fact using boolean values will not work and won't translate to `on` or `off` Release Notes: - N/A --- docs/src/configuring-languages.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/configuring-languages.md b/docs/src/configuring-languages.md index 65e9f822b9..fc6de9efea 100644 --- a/docs/src/configuring-languages.md +++ b/docs/src/configuring-languages.md @@ -33,7 +33,7 @@ Here's an example of language-specific settings: "Python": { "tab_size": 4, "formatter": "language_server", - "format_on_save": true + "format_on_save": "on" }, "JavaScript": { "tab_size": 2, @@ -209,11 +209,11 @@ Zed supports both built-in and external formatters. Configure formatters globall "arguments": ["--stdin-filepath", "{buffer_path}"] } }, - "format_on_save": true + "format_on_save": "on" }, "Rust": { "formatter": "language_server", - "format_on_save": true + "format_on_save": "on" } } ``` @@ -225,7 +225,7 @@ To disable formatting for a specific language: ```json "languages": { "Markdown": { - "format_on_save": false + "format_on_save": "off" } } ``` @@ -276,7 +276,7 @@ Zed allows you to run both formatting and linting on save. Here's an example tha "code_actions_on_format": { "source.fixAll.eslint": true }, - "format_on_save": true + "format_on_save": "on" } } ```