docs: Update scrollbar > diagnostics setting section (#22574)

Bennet Bo Fenner created 1 year ago

This updates the docs after the setting was changed in #22364 

Release Notes:

- N/A

Change summary

assets/settings/default.json         |  2 
crates/editor/src/editor_settings.rs |  9 +----
docs/src/configuring-zed.md          | 46 +++++++++++++++++++++++++++--
3 files changed, 45 insertions(+), 12 deletions(-)

Detailed changes

assets/settings/default.json

@@ -256,7 +256,7 @@
     "search_results": true,
     // Whether to show selected symbol occurrences in the scrollbar.
     "selected_symbol": true,
-    // Which diagnostic indicator levels to show in the scrollbar:
+    // Which diagnostic indicators to show in the scrollbar:
     //  - "none" or false: do not show diagnostics
     //  - "error": show only errors
     //  - "warning": show only errors and warnings

crates/editor/src/editor_settings.rs

@@ -150,7 +150,7 @@ pub struct ScrollbarAxes {
     pub vertical: bool,
 }
 
-/// Which diagnostic indicator levels to show in the scrollbar.
+/// Which diagnostic indicators to show in the scrollbar.
 ///
 /// Default: all
 #[derive(Copy, Clone, Debug, Serialize, JsonSchema, PartialEq, Eq)]
@@ -415,12 +415,7 @@ pub struct ScrollbarContent {
     ///
     /// Default: true
     pub selected_symbol: Option<bool>,
-    /// Which diagnostic indicator levels to show in the scrollbar:
-    ///  - "none" or false: do not show diagnostics
-    ///  - "error": show only errors
-    ///  - "warning": show only errors and warnings
-    ///  - "information": show only errors, warnings, and information
-    ///  - "all" or true: show all diagnostics
+    /// Which diagnostic indicators to show in the scrollbar:
     ///
     /// Default: all
     pub diagnostics: Option<ScrollbarDiagnostics>,

docs/src/configuring-zed.md

@@ -534,7 +534,7 @@ List of `string` values
   "git_diff": true,
   "search_results": true,
   "selected_symbol": true,
-  "diagnostics": true,
+  "diagnostics": "all",
   "axes": {
     "horizontal": true,
     "vertical": true,
@@ -624,13 +624,51 @@ List of `string` values
 
 ### Diagnostics
 
-- Description: Whether to show diagnostic indicators in the scrollbar.
+- Description: Which diagnostic indicators to show in the scrollbar.
 - Setting: `diagnostics`
-- Default: `true`
+- Default: `all`
 
 **Options**
 
-`boolean` values
+1. Show all diagnostics:
+
+```json
+{
+  "diagnostics": "all"
+}
+```
+
+2. Do not show any diagnostics:
+
+```json
+{
+  "diagnostics": "none"
+}
+```
+
+3. Show only errors:
+
+```json
+{
+  "diagnostics": "error"
+}
+```
+
+4. Show only errors and warnings:
+
+```json
+{
+  "diagnostics": "warning"
+}
+```
+
+5. Show only errors, warnings, and information:
+
+```json
+{
+  "diagnostics": "information"
+}
+```
 
 ### Axes