accounts.email: add clarifying documentation

Add clarifying documentation for maildirBasePath value. Also improve
default text.
This commit is contained in:
Jdogzz 2024-06-04 11:23:39 -07:00 committed by GitHub
parent 2cacdd6a27
commit a7117efb37
Failed to generate hash of commit

View file

@ -493,13 +493,14 @@ in {
maildirBasePath = mkOption { maildirBasePath = mkOption {
type = types.str; type = types.str;
default = "${config.home.homeDirectory}/Maildir"; default = "${config.home.homeDirectory}/Maildir";
defaultText = "$HOME/Maildir"; defaultText = "Maildir";
apply = p: apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}"; if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = '' description = ''
The base directory for account maildir directories. May be a The base directory for account maildir directories. May be a
relative path, in which case it is relative the home relative path (e.g. the user setting this value as "MyMaildir"),
directory. in which case it is relative the home directory (e.g. resulting
in "~/MyMaildir").
''; '';
}; };