doc: document imageScalingMode options (#709)

Document the imageScalingMode options according to swaybg, which should be mostly universal. Link: #709 Reviewed-by: NAHO <[email protected]> (cherry picked from commit f48cab3)
danth · Jan 4, 2025 · 9593bd5 · 9593bd5
1 parent 21b1b0c
commit 9593bd5
Showing 1 changed file with 15 additions and 3 deletions.
diff --git 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.
       '';
     };