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

treewide: convert custom enable docs to Markdown

Browse source 
`nix-doc-munge` can't tell what's going on with this pattern, so I
just handled them all manually.
This commit is contained in:
Emily 2023-07-01 08:48:09 +01:00
parent 3222c99a91
commit 9e4a73c25e
10 changed files with 52 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

3
modules/programs/atuin.nix
View file

@ -30,7 +30,8 @@ in {
'';
};
enableZshIntegration = mkEnableOption "Zsh integration" // {
enableZshIntegration = mkOption {
type = types.bool;
default = true;
description = ''
Whether to enable Atuin's Zsh integration.

24
modules/programs/git.nix
View file

@ -265,10 +265,10 @@ in {
};
difftastic = {
enable = mkEnableOption "" // {
description = ''
Enable the <command>difftastic</command> syntax highlighter.
See <link xlink:href="https://github.com/Wilfred/difftastic" />.
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Enable the {command}`difftastic` syntax highlighter.
See <https://github.com/Wilfred/difftastic>.
'';
};
@ -303,10 +303,10 @@ in {
};
delta = {
enable = mkEnableOption "" // {
description = ''
Whether to enable the <command>delta</command> syntax highlighter.
See <link xlink:href="https://github.com/dandavison/delta" />.
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Whether to enable the {command}`delta` syntax highlighter.
See <https://github.com/dandavison/delta>.
'';
};
@ -335,10 +335,10 @@ in {
};
diff-so-fancy = {
enable = mkEnableOption "" // {
description = ''
Enable the <command>diff-so-fancy</command> diff colorizer.
See <link xlink:href="https://github.com/so-fancy/diff-so-fancy" />.
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Enable the {command}`diff-so-fancy` diff colorizer.
See <https://github.com/so-fancy/diff-so-fancy>.
'';
};

8
modules/programs/java.nix
View file

@ -14,10 +14,10 @@ in {
options = {
programs.java = {
enable = mkEnableOption "" // {
description = ''
Install the Java development kit and set the <envar>JAVA_HOME</envar>
variable.
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Install the Java development kit and set the
{env}`JAVA_HOME` variable.
'';
};