From 0a65d3ae070d76c50b2ab4369fb81d88c206b9e4 Mon Sep 17 00:00:00 2001
From: Bart Bakker <bart@thesoftwarecraft.com>
Date: Sun, 26 Nov 2023 14:44:30 +0100
Subject: [PATCH] htop: describe screen options

---
 modules/programs/htop.nix | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/modules/programs/htop.nix b/modules/programs/htop.nix
index 3e84591c3..f5a5a2c9c 100644
--- a/modules/programs/htop.nix
+++ b/modules/programs/htop.nix
@@ -92,44 +92,55 @@ let
   blank = text "Blank";
 
   screenOptions = {
-    name = mkOption { type = types.str; };
+    name = mkOption {
+      type = types.str;
+      description = "Name that shows on the screen tab.";
+    };
 
     fields = mkOption {
       type = types.oneOf [ types.str (types.listOf types.str) ];
       default = "PID USER M_VIRT STATE PERCENT_CPU PERCENT_MEM TIME Command";
+      description = "What fields to show in the screen.";
     };
 
     all_branches_collapsed = mkOption {
       type = types.bool;
       default = false;
+      description = "Whether to collapse all branches in the tree view.";
     };
 
     sort_direction = mkOption {
       type = types.enum [ (-1) 1 ];
       default = -1;
+      description = "Whether to sort ascending or descending.";
     };
     sort_key = mkOption {
       type = types.str;
       example = "PERCENT_MEM";
+      description = "Key to sort by.";
     };
 
     tree_sort_direction = mkOption {
       type = types.enum [ (-1) 1 ];
       default = -1;
+      description = "Whether to sort the tree ascending or descending.";
     };
     tree_sort_key = mkOption {
       type = types.str;
       example = "PERCENT_MEM";
+      description = "Key to sort the three by.";
     };
 
     tree_view = mkOption {
       type = types.bool;
       default = false;
+      description = "Whether the use a tree view.";
     };
 
     tree_view_always_by_pid = mkOption {
       type = types.bool;
       default = false;
+      description = "Whther the tree view groups by pid.";
     };
   };
 
@@ -213,6 +224,9 @@ in {
           };
         };
       '';
+      description = ''
+        List of screens.
+      '';
     };
 
     package = mkOption {