Skip to content

Commit

Permalink
docs: Update scrollbar > diagnostics setting section (#22574)
Browse files Browse the repository at this point in the history
This updates the docs after the setting was changed in #22364 

Release Notes:

- N/A
  • Loading branch information
bennetbo authored Jan 2, 2025
1 parent b009e72 commit fbef8c2
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 12 deletions.
2 changes: 1 addition & 1 deletion assets/settings/default.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 2 additions & 7 deletions crates/editor/src/editor_settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down Expand Up @@ -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>,
Expand Down
46 changes: 42 additions & 4 deletions docs/src/configuring-zed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit fbef8c2

Please sign in to comment.