movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

nixos/programs: invariant option docs MD conversions

Browse source
This commit is contained in:
pennae 2022-07-20 12:32:04 +02:00
parent 4f91838584
commit da37ca6760
9 changed files with 74 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

20
nixos/modules/programs/less.nix
View file

@ -41,12 +41,12 @@ in
type = types.nullOr types.path;
default = null;
example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';
description = ''
description = lib.mdDoc ''
Path to lesskey configuration file.
<option>configFile</option> takes precedence over <option>commands</option>,
<option>clearDefaultCommands</option>, <option>lineEditingKeys</option>, and
<option>envVariables</option>.
{option}`configFile` takes precedence over {option}`commands`,
{option}`clearDefaultCommands`, {option}`lineEditingKeys`, and
{option}`envVariables`.
'';
};
@ -57,13 +57,13 @@ in
h = "noaction 5\\e(";
l = "noaction 5\\e)";
};
description = "Defines new command keys.";
description = lib.mdDoc "Defines new command keys.";
};
clearDefaultCommands = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Clear all default commands.
You should remember to set the quit key.
Otherwise you will not be able to leave less without killing it.
@ -76,7 +76,7 @@ in
example = {
e = "abort";
};
description = "Defines new line-editing keys.";
description = lib.mdDoc "Defines new line-editing keys.";
};
envVariables = mkOption {
@ -87,14 +87,14 @@ in
example = {
LESS = "--quit-if-one-screen";
};
description = "Defines environment variables.";
description = lib.mdDoc "Defines environment variables.";
};
lessopen = mkOption {
type = types.nullOr types.str;
default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";
defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"'';
description = ''
description = lib.mdDoc ''
Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.
'';
};
@ -102,7 +102,7 @@ in
lessclose = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN).
'';
};