nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

treewide: convert all option docs to Markdown

Browse source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily 2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download patch file Download diff file Expand all files Collapse all files

43
modules/programs/nushell.nix
View file

@ -22,8 +22,8 @@ let
"";
defaultText = literalExpression
"if source is defined, the content of source, otherwise empty";
description = ''
Text of the nushell <filename>${name}</filename> file.
description = lib.mdDoc ''
Text of the nushell {file}`${name}` file.
If unset then the source option will be preferred.
'';
};
@ -31,8 +31,8 @@ let
source = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
Path of the nushell <filename>${name}</filename> file to use.
description = lib.mdDoc ''
Path of the nushell {file}`${name}` file to use.
If the text option is set, it will be preferred.
'';
};
@ -52,13 +52,13 @@ in {
];
options.programs.nushell = {
enable = mkEnableOption "nushell";
enable = mkEnableOption (lib.mdDoc "nushell");
package = mkOption {
type = types.package;
default = pkgs.nushell;
defaultText = literalExpression "pkgs.nushell";
description = "The package to use for nushell.";
description = lib.mdDoc "The package to use for nushell.";
};
configFile = mkOption {
@ -74,11 +74,10 @@ in {
''';
}
'';
description = ''
description = lib.mdDoc ''
The configuration file to be used for nushell.
</para>
<para>
See <link xlink:href="https://www.nushell.sh/book/configuration.html#configuration" /> for more information.
See <https://www.nushell.sh/book/configuration.html#configuration> for more information.
'';
};
@ -88,11 +87,10 @@ in {
example = ''
let-env FOO = 'BAR'
'';
description = ''
description = lib.mdDoc ''
The environment variables file to be used for nushell.
</para>
<para>
See <link xlink:href="https://www.nushell.sh/book/configuration.html#configuration" /> for more information.
See <https://www.nushell.sh/book/configuration.html#configuration> for more information.
'';
};
@ -105,18 +103,17 @@ in {
echo "Hello, World"
}
'';
description = ''
description = lib.mdDoc ''
The login file to be used for nushell upon logging in.
</para>
<para>
See <link xlink:href="https://www.nushell.sh/book/configuration.html#configuring-nu-as-a-login-shell" /> for more information.
See <https://www.nushell.sh/book/configuration.html#configuring-nu-as-a-login-shell> for more information.
'';
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional configuration to add to the nushell configuration file.
'';
};
@ -124,7 +121,7 @@ in {
extraEnv = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional configuration to add to the nushell environment variables file.
'';
};
@ -132,7 +129,7 @@ in {
extraLogin = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional configuration to add to the nushell login file.
'';
};
@ -141,7 +138,7 @@ in {
type = types.attrsOf types.str;
default = { };
example = { ll = "ls -l"; };
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.
'';
@ -151,7 +148,7 @@ in {
type = types.attrsOf types.str;
default = { };
example = { FOO = "BAR"; };
description = ''
description = lib.mdDoc ''
An attribute set that maps an environment variable to a shell interpreted string.
'';
};