From 62d69e95a5ad53f7f52bf6abeb3e01068bcdef86 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Fri, 1 Dec 2023 22:09:52 -0800 Subject: [PATCH] config: improve docs for minimum-contrast --- src/config/Config.zig | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/config/Config.zig b/src/config/Config.zig index 4b4231455..e59fb2843 100644 --- a/src/config/Config.zig +++ b/src/config/Config.zig @@ -199,6 +199,13 @@ foreground: Color = .{ .r = 0xFF, .g = 0xFF, .b = 0xFF }, /// colors. The contrast ratio is a value between 1 and 21. A value of /// 1 allows for no contrast (i.e. black on black). This value is /// the contrast ratio as defined by the WCAG 2.0 specification. +/// +/// If you want to avoid invisible text (same color as background), +/// a value of 1.1 is a good value. If you want to avoid text that is +/// difficult to read, a value of 3 or higher is a good value. The higher +/// the value, the more likely that text will become black or white. +/// +/// This value does not apply to Emoji or images. @"minimum-contrast": f64 = 1, /// Color palette for the 256 color form that many terminal applications