From f48cab39ba162c5eaef3d975aaac467c20db402b Mon Sep 17 00:00:00 2001
From: hazel <hazel@meows.zip>
Date: Tue, 31 Dec 2024 09:05:32 -0800
Subject: [PATCH] doc: document imageScalingMode options (#709)

Document the imageScalingMode options according to swaybg, which should
be mostly universal.

Link: https://github.com/danth/stylix/pull/709

Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
---
 stylix/palette.nix | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/stylix/palette.nix b/stylix/palette.nix
index 7fe9600a..e299d68d 100644
--- a/stylix/palette.nix
+++ b/stylix/palette.nix
@@ -48,10 +48,22 @@ in {
       type = lib.types.enum [ "stretch" "fill" "fit" "center" "tile" ];
       default = "fill";
       description = ''
-        Wallpaper scaling mode;
+        Scaling mode for the wallpaper image.
 
-        This is the scaling mode your wallpaper image will use assuming it
-        doesnt fix your monitor perfectly
+        `stretch`
+        : Stretch the image to cover the screen.
+
+        `fill`
+        : Scale the image to fill the screen, potentially cropping it.
+
+        `fit`
+        : Scale the image to fit the screen without being cropped.
+
+        `center`
+        : Center the image without resizing it.
+
+        `tile`
+        : Tile the image to cover the screen.
       '';
     };