nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 11:36:05 +01:00
Code Activity

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

16
modules/xresources.nix
View file

@ -43,15 +43,15 @@ in {
"XTerm*charClass" = [ "37:48" "45-47:48" "58:48" "64:48" "126:48" ];
}
'';
description = ''
description = lib.mdDoc ''
X server resources that should be set.
Booleans are formatted as "true" or "false" respectively.
List elements are recursively formatted as a string and joined by commas.
All other values are directly formatted using builtins.toString.
Note, that 2-dimensional lists are not supported and specifying one will throw an exception.
If this and all other xresources options are
<literal>null</literal>, then this feature is disabled and no
<filename>~/.Xresources</filename> link is produced.
`null`, then this feature is disabled and no
{file}`~/.Xresources` link is produced.
'';
};
@ -68,11 +68,11 @@ in {
} + "/Xresources.dark"
)
'';
description = ''
description = lib.mdDoc ''
Additional X server resources contents.
If this and all other xresources options are
<literal>null</literal>, then this feature is disabled and no
<filename>~/.Xresources</filename> link is produced.
`null`, then this feature is disabled and no
{file}`~/.Xresources` link is produced.
'';
};
@ -80,8 +80,8 @@ in {
type = types.str;
default = "${config.home.homeDirectory}/.Xresources";
defaultText = "$HOME/.Xresources";
description =
"Path where Home Manager should link the <filename>.Xresources</filename> file.";
description = lib.mdDoc
"Path where Home Manager should link the {file}`.Xresources` file.";
};
};