Update docs for some settings (#27293)

- update tooltips of `auto_install_extensions` , `active_pane_modifiers`
- update docs of `auto_install_extensions`, `active_pane_modifiers`,
`buffer_line_height`

Release Notes:

- N/A

---------

Co-authored-by: Kirill Bulatov <mail4score@gmail.com>
This commit is contained in:
Junseong Park 2025-03-24 20:05:06 +09:00 committed by GitHub
parent 08e8109e79
commit 07727f939e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 25 additions and 3 deletions

View file

@ -12,6 +12,8 @@ pub struct ExtensionSettings {
/// ///
/// This is used to make functionality provided by extensions (e.g., language support) /// This is used to make functionality provided by extensions (e.g., language support)
/// available out-of-the-box. /// available out-of-the-box.
///
/// Default: { "html": true }
#[serde(default)] #[serde(default)]
pub auto_install_extensions: HashMap<Arc<str>, bool>, pub auto_install_extensions: HashMap<Arc<str>, bool>,
#[serde(default)] #[serde(default)]

View file

@ -31,7 +31,19 @@ Extensions that provide language servers may also provide default settings for t
## Active Pane Modifiers ## Active Pane Modifiers
Styling settings applied to the active pane. - Description: Styling settings applied to the active pane.
- Setting: `active_pane_modifiers`
- Default:
```json
{
"active_pane_modifiers": {
"magnification": 1.0,
"border_size": 0.0,
"inactive_opacity": 1.0
}
}
```
### Magnification ### Magnification
@ -39,12 +51,20 @@ Styling settings applied to the active pane.
- Setting: `magnification` - Setting: `magnification`
- Default: `1.0` - Default: `1.0`
**Options**
`float` values
### Border size ### Border size
- Description: Size of the border surrounding the active pane. When set to 0, the active pane doesn't have any border. The border is drawn inset. - Description: Size of the border surrounding the active pane. When set to 0, the active pane doesn't have any border. The border is drawn inset.
- Setting: `border_size` - Setting: `border_size`
- Default: `0.0` - Default: `0.0`
**Options**
Non-negative `float` values
### Inactive Opacity ### Inactive Opacity
- Description: Opacity of inactive panels. When set to 1.0, the inactive panes have the same opacity as the active one. If set to 0, the inactive panes content will not be visible at all. Values are clamped to the [0.0, 1.0] range. - Description: Opacity of inactive panels. When set to 1.0, the inactive panes have the same opacity as the active one. If set to 0, the inactive panes content will not be visible at all. Values are clamped to the [0.0, 1.0] range.
@ -59,7 +79,7 @@ Styling settings applied to the active pane.
- Description: Define extensions to be autoinstalled or never be installed. - Description: Define extensions to be autoinstalled or never be installed.
- Setting: `auto_install_extension` - Setting: `auto_install_extension`
- Default: `{"html": true}` - Default: `{ "html": true }`
**Options** **Options**
@ -327,7 +347,7 @@ For example, to use `Nerd Font` as a fallback, add the following to your setting
**Options** **Options**
`"standard"`, `"comfortable"` or `{"custom": float}` (`1` is very compact, `2` very loose) `"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
## Confirm Quit ## Confirm Quit