summaryrefslogtreecommitdiff
path: root/modules/services/spacebar
diff options
context:
space:
mode:
authorEmily <vcs@emily.moe>2023-06-22 12:21:32 +0100
committerEmily <vcs@emily.moe>2023-06-24 10:48:55 +0100
commite65131e69cab1b18fb49b572b983a18720502e1b (patch)
tree8bfb50580aad1bc01db494a138ac0855bfc518b3 /modules/services/spacebar
parentefe314cdbabaf5cd210d9c658b4ad540437b7ee5 (diff)
treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]; thanks to @pennae for writing this tool! It automatically checks that the resulting documentation doesn't change, although my fork loosens this a little to ignore some irrelevant whitespace and typographical differences. As of this commit there is no DocBook remaining in the options documentation. You can play along at home if you want to reproduce this commit: $ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \ {} + [my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
Diffstat (limited to 'modules/services/spacebar')
-rw-r--r--modules/services/spacebar/default.nix8
1 files changed, 4 insertions, 4 deletions
diff --git a/modules/services/spacebar/default.nix b/modules/services/spacebar/default.nix
index a56dac5..eb06cad 100644
--- a/modules/services/spacebar/default.nix
+++ b/modules/services/spacebar/default.nix
@@ -22,12 +22,12 @@ in
services.spacebar.enable = mkOption {
type = bool;
default = false;
- description = "Whether to enable the spacebar spacebar.";
+ description = lib.mdDoc "Whether to enable the spacebar spacebar.";
};
services.spacebar.package = mkOption {
type = path;
- description = "The spacebar package to use.";
+ description = lib.mdDoc "The spacebar package to use.";
};
services.spacebar.config = mkOption {
@@ -40,7 +40,7 @@ in
foreground_color = "0xffa8a8a8";
}
'';
- description = ''
+ description = lib.mdDoc ''
Key/Value pairs to pass to spacebar's 'config' domain, via the configuration file.
'';
};
@@ -51,7 +51,7 @@ in
example = literalExpression ''
echo "spacebar config loaded..."
'';
- description = ''
+ description = lib.mdDoc ''
Extra arbitrary configuration to append to the configuration file.
'';
};