From c23060ce95c4856157789b0636e1b6206be335c4 Mon Sep 17 00:00:00 2001
From: TheRealGramdalf <79593869+TheRealGramdalf@users.noreply.github.com>
Date: Thu, 4 Jul 2024 23:07:22 +0000
Subject: [PATCH] hyprland: emphasize usage of the NixOS module

---
 modules/services/window-managers/hyprland.nix | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/modules/services/window-managers/hyprland.nix b/modules/services/window-managers/hyprland.nix
index 8fbdc6b7c..73602ec61 100644
--- a/modules/services/window-managers/hyprland.nix
+++ b/modules/services/window-managers/hyprland.nix
@@ -40,7 +40,21 @@ in {
   ];
 
   options.wayland.windowManager.hyprland = {
-    enable = lib.mkEnableOption "Hyprland wayland compositor";
+    enable = lib.mkOption {
+      type = lib.types.bool;
+      default = false;
+      description = ''
+        Whether to enable configuration for Hyprland, a tiling Wayland
+        compositor that doesn't sacrifice on its looks.
+
+        ::: {.note}
+        This module configures Hyprland and adds it to your user's {env}`PATH`,
+        but does not make certain system-level changes. NixOS users should
+        enable the NixOS module with {option}`programs.hyprland.enable`, which
+        makes system-level changes such as adding a desktop session entry.
+        :::
+      '';
+    };
 
     package = lib.mkPackageOption pkgs "hyprland" { };