From af18adb192708b8f0896ca09689eec571e2a8e84 Mon Sep 17 00:00:00 2001 From: Anton Kastritskii Date: Mon, 1 Jul 2024 15:02:22 +0100 Subject: [PATCH] docs: add valid values for enum config options fixes #1899 --- src/config/Config.zig | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/src/config/Config.zig b/src/config/Config.zig index 4340eb5c7..4518d91ac 100644 --- a/src/config/Config.zig +++ b/src/config/Config.zig @@ -297,6 +297,13 @@ palette: Palette = .{}, /// a prompt, regardless of this configuration. You can disable that behavior /// by specifying `shell-integration-features = no-cursor` or disabling shell /// integration entirely. +/// +/// Valid values are: +/// +/// * `block` +/// * `bar` +/// * `underline` +/// @"cursor-style": terminal.CursorStyle = .block, /// Sets the default blinking state of the cursor. This is just the default @@ -310,6 +317,12 @@ palette: Palette = .{}, /// (AT&T cursor blink) as an alternate approach to turning blinking on/off. If /// this is set to any value other than null, DEC mode 12 will be ignored but /// `DECSCUSR` will still be respected. +/// +/// Valid values are: +/// +/// * `true` +/// * `false` +/// @"cursor-style-blink": ?bool = null, /// The color of the text under the cursor. If this is not set, a default will @@ -354,6 +367,14 @@ palette: Palette = .{}, /// /// If you always want shift to extend mouse selection even if the program /// requests otherwise, set this to `never`. +/// +/// Valid values are: +/// +/// * `true` +/// * `false` +/// * `always` +/// * `never` +/// @"mouse-shift-capture": MouseShiftCapture = .false, /// Multiplier for scrolling distance with the mouse wheel. Any value less @@ -769,6 +790,13 @@ keybind: Keybinds = .{}, /// Whether to allow programs running in the terminal to read/write to the /// system clipboard (OSC 52, for googling). The default is to allow clipboard /// reading after prompting the user and allow writing unconditionally. +/// +/// Valid values are: +/// +/// * `ask` +/// * `allow` +/// * `deny` +/// @"clipboard-read": ClipboardAccess = .ask, @"clipboard-write": ClipboardAccess = .allow,