nix-community/nix-on-droid
1
0
Fork 0
mirror of https://github.com/nix-community/nix-on-droid.git synced 2025-11-08 11:36:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

treewide: improve option descriptions

Browse source
This commit is contained in:
Tobias Happ 2022-10-26 12:05:14 +02:00
parent 7b039faa83
commit b76fb0954e
10 changed files with 50 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

14
modules/home-manager.nix
View file

@ -53,7 +53,10 @@ in
default = null;
# Prevent the entire submodule being included in the documentation.
visible = "shallow";
description = "Home Manager configuration.";
description = ''
Home Manager configuration, see
<link xlink:href="https://nix-community.github.io/home-manager/options.html" />.
'';
};
extraSpecialArgs = mkOption {
@ -67,14 +70,7 @@ in
};
sharedModules = mkOption {
type = with types;
# TODO: use types.raw once this PR is merged: https://github.com/NixOS/nixpkgs/pull/132448
listOf (mkOptionType {
name = "submodule";
inherit (submodule { }) check;
merge = lib.options.mergeOneOption;
description = "Home Manager modules";
});
type = with types; listOf raw;
default = [ ];
example = literalExpression "[ { home.packages = [ nixpkgs-fmt ]; } ]";
description = ''