From f6cbee9e270b18681c2b39ad507bb128b98a35a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tau=20G=C3=A4rtli?= Date: Sat, 7 Sep 2024 21:35:37 +0200 Subject: [PATCH] Update docs --- src/theme.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/theme.rs b/src/theme.rs index 71c09e98..b8c4c67b 100644 --- a/src/theme.rs +++ b/src/theme.rs @@ -43,7 +43,8 @@ pub fn color_scheme(when: DetectColorScheme) -> Option { /// Used together with [`theme`]. #[derive(Debug, Clone, Default, PartialEq, Eq)] pub struct ThemeOptions { - /// Always use this theme regardless of the terminal's background color. + /// Configures how the theme is chosen. If set to a [`ThemePreference::Fixed`] value, + /// then the given theme is used regardless of the terminal's background color. /// This corresponds with the `BAT_THEME` environment variable and the `--theme` option. pub theme: ThemePreference, /// The theme to use in case the terminal uses a dark background with light text.