summaryrefslogtreecommitdiff
path: root/modules/lib/write-text.nix
diff options
context:
space:
mode:
authorDaiderd Jordan <daiderd@gmail.com>2023-06-24 23:42:39 +0200
committerGitHub <noreply@github.com>2023-06-24 23:42:39 +0200
commitace0ef2a26bc428e768a5926eae95a63cfcf8b52 (patch)
tree60506865a377eedabf6b77e2da800775c2435d41 /modules/lib/write-text.nix
parent6460468e7a3e1290f132fee4170ebeaa127f6f32 (diff)
parent9d6702cf2b81f5d0ef9d628d99e8deb45f84b454 (diff)
Merge pull request #707 from emilazy/options-markdown-migration
Migrate option documentation to Markdown
Diffstat (limited to 'modules/lib/write-text.nix')
-rw-r--r--modules/lib/write-text.nix10
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/lib/write-text.nix b/modules/lib/write-text.nix
index 2fe02af..b8f2ad5 100644
--- a/modules/lib/write-text.nix
+++ b/modules/lib/write-text.nix
@@ -16,7 +16,7 @@ in
enable = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether this file should be generated.
This option allows specific files to be disabled.
'';
@@ -25,7 +25,7 @@ in
text = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Text of the file.
'';
};
@@ -33,14 +33,14 @@ in
target = mkOption {
type = types.str;
default = name;
- description = ''
+ description = lib.mdDoc ''
Name of symlink. Defaults to the attribute name.
'';
};
source = mkOption {
type = types.path;
- description = ''
+ description = lib.mdDoc ''
Path of the source file.
'';
};
@@ -48,7 +48,7 @@ in
copy = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether this file should be copied instead of symlinking.
'';
};