From 5fb55d51e2dcdc0dd5f6c82968c3edff00d73b2b Mon Sep 17 00:00:00 2001 From: Robert Helgesson Date: Thu, 6 Jan 2022 09:22:42 +0100 Subject: [PATCH] swayidle: fix option documentation --- modules/services/swayidle.nix | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/services/swayidle.nix b/modules/services/swayidle.nix index 4a6c5b2f..6cbf840b 100644 --- a/modules/services/swayidle.nix +++ b/modules/services/swayidle.nix @@ -27,19 +27,19 @@ in { options = { timeout = mkOption { type = types.ints.positive; - description = "Timeout in seconds"; example = 60; + description = "Timeout in seconds."; }; command = mkOption { type = types.str; - description = "Command to run after timeout seconds of inactivity"; + description = "Command to run after timeout seconds of inactivity."; }; resumeCommand = mkOption { type = with types; nullOr str; default = null; - description = "Command to run when there is activity again"; + description = "Command to run when there is activity again."; }; }; }; @@ -48,18 +48,18 @@ in { options = { event = mkOption { type = types.enum [ "before-sleep" "after-resume" "lock" "unlock" ]; - description = "Event name"; + description = "Event name."; }; command = mkOption { type = types.str; - description = "Command to run when event occurs"; + description = "Command to run when event occurs."; }; }; }; in { - enable = mkEnableOption "Idle manager for Wayland"; + enable = mkEnableOption "idle manager for Wayland"; package = mkOption { type = types.package; @@ -71,30 +71,30 @@ in { timeouts = mkOption { type = with types; listOf (submodule timeoutModule); default = [ ]; - description = "List of commands to run after idle timeout"; - example = '' + example = literalExpression '' [ { timeout = 60; command = "swaylock -fF"; } ] ''; + description = "List of commands to run after idle timeout."; }; events = mkOption { type = with types; listOf (submodule eventModule); default = [ ]; - example = '' + example = literalExpression '' [ { event = "before-sleep"; command = "swaylock"; } { event = "lock"; command = "lock"; } ] ''; - description = "Run command on occurence of a event"; + description = "Run command on occurence of a event."; }; extraArgs = mkOption { type = with types; listOf str; default = [ ]; - description = "Extra arguments to pass to swayidle"; + description = "Extra arguments to pass to swayidle."; }; };