random-background: minor documentation improvements

This commit is contained in:
Robert Helgesson 2019-03-24 15:26:54 +01:00
parent 2e1c825b90
commit cf5dac9563
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89

View file

@ -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.
'';
};
};