From cf5dac9563d9376abc5e81eb9f92ac533e80d531 Mon Sep 17 00:00:00 2001
From: Robert Helgesson <robert@rycee.net>
Date: Sun, 24 Mar 2019 15:26:54 +0100
Subject: [PATCH] random-background: minor documentation improvements
---
modules/services/random-background.nix | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/modules/services/random-background.nix b/modules/services/random-background.nix
index 4f0a4c431..2af7af0b1 100644
--- a/modules/services/random-background.nix
+++ b/modules/services/random-background.nix
@@ -17,22 +17,22 @@ in
imageDirectory = mkOption {
type = types.str;
- description =
- ''
- The directory of images from which a background should be
- chosen. Should be formatted in a way understood by
- systemd, e.g., '%h' is the home directory.
- '';
+ example = "%h/backgrounds";
+ description = ''
+ The directory of images from which a background should be
+ chosen. Should be formatted in a way understood by systemd,
+ e.g., '%h' is the home directory.
+ '';
};
interval = mkOption {
default = null;
type = types.nullOr types.str;
+ example = "1h";
description = ''
The duration between changing background image, set to null
- to only set background when logging in.
-
- Should be formatted as a duration understood by systemd.
+ to only set background when logging in. Should be formatted
+ as a duration understood by systemd.
'';
};
};