summaryrefslogtreecommitdiff
path: root/modules/programs/fish.nix
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/programs/fish.nix
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/programs/fish.nix')
-rw-r--r--modules/programs/fish.nix28
1 files changed, 14 insertions, 14 deletions
diff --git a/modules/programs/fish.nix b/modules/programs/fish.nix
index 7a1ba10..434449f 100644
--- a/modules/programs/fish.nix
+++ b/modules/programs/fish.nix
@@ -51,7 +51,7 @@ in
enable = mkOption {
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to configure fish as an interactive shell.
'';
type = types.bool;
@@ -60,15 +60,15 @@ in
useBabelfish = mkOption {
type = types.bool;
default = false;
- description = ''
- If enabled, the configured environment will be translated to native fish using <link xlink:href="https://github.com/bouk/babelfish">babelfish</link>.
- Otherwise, <link xlink:href="https://github.com/oh-my-fish/plugin-foreign-env">foreign-env</link> will be used.
+ description = lib.mdDoc ''
+ If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish).
+ Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used.
'';
};
babelfishPackage = mkOption {
type = types.package;
- description = ''
+ description = lib.mdDoc ''
The babelfish package to use when useBabelfish is
set to true.
'';
@@ -77,7 +77,7 @@ in
vendor.config.enable = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether fish should source configuration snippets provided by other packages.
'';
};
@@ -85,7 +85,7 @@ in
vendor.completions.enable = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether fish should use completion files provided by other packages.
'';
};
@@ -93,15 +93,15 @@ in
vendor.functions.enable = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether fish should autoload fish functions provided by other packages.
'';
};
shellAliases = mkOption {
default = config.environment.shellAliases;
- description = ''
- Set of aliases for fish shell. See <option>environment.shellAliases</option>
+ description = lib.mdDoc ''
+ Set of aliases for fish shell. See {option}`environment.shellAliases`
for an option format description.
'';
type = types.attrs;
@@ -109,7 +109,7 @@ in
shellInit = mkOption {
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell script code called during fish shell initialisation.
'';
type = types.lines;
@@ -117,7 +117,7 @@ in
loginShellInit = mkOption {
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell script code called during fish login shell initialisation.
'';
type = types.lines;
@@ -125,7 +125,7 @@ in
interactiveShellInit = mkOption {
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell script code called during interactive fish shell initialisation.
'';
type = types.lines;
@@ -133,7 +133,7 @@ in
promptInit = mkOption {
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell script code used to initialise fish prompt.
'';
type = types.lines;