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

treewide: remove now-redundant lib.mdDoc calls

Browse source 
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

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 \
      --strip {} +
    $ ./format
This commit is contained in:
Emily 2023-07-02 00:45:18 +01:00
parent 7398af11b8
commit 9f9e277b60
360 changed files with 2672 additions and 2853 deletions
Download patch file Download diff file Expand all files Collapse all files

31
modules/programs/vscode.nix
View file

@ -60,14 +60,14 @@ in {
options = {
programs.vscode = {
enable = mkEnableOption (lib.mdDoc "Visual Studio Code");
enable = mkEnableOption "Visual Studio Code";
package = mkOption {
type = types.package;
default = pkgs.vscode;
defaultText = literalExpression "pkgs.vscode";
example = literalExpression "pkgs.vscodium";
description = lib.mdDoc ''
description = ''
Version of Visual Studio Code to install.
'';
};
@ -75,7 +75,7 @@ in {
enableUpdateCheck = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable update checks/notifications.
'';
};
@ -83,7 +83,7 @@ in {
enableExtensionUpdateCheck = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable update notifications for extensions.
'';
};
@ -97,7 +97,7 @@ in {
"[nix]"."editor.tabSize" = 2;
}
'';
description = lib.mdDoc ''
description = ''
Configuration written to Visual Studio Code's
{file}`settings.json`.
'';
@ -118,7 +118,7 @@ in {
];
}
'';
description = lib.mdDoc ''
description = ''
Configuration written to Visual Studio Code's
{file}`tasks.json`.
'';
@ -130,20 +130,20 @@ in {
key = mkOption {
type = types.str;
example = "ctrl+c";
description = lib.mdDoc "The key or key-combination to bind.";
description = "The key or key-combination to bind.";
};
command = mkOption {
type = types.str;
example = "editor.action.clipboardCopyAction";
description = lib.mdDoc "The VS Code command to execute.";
description = "The VS Code command to execute.";
};
when = mkOption {
type = types.nullOr (types.str);
default = null;
example = "textInputFocus";
description = lib.mdDoc "Optional context filter.";
description = "Optional context filter.";
};
# https://code.visualstudio.com/docs/getstarted/keybindings#_command-arguments
@ -151,7 +151,7 @@ in {
type = types.nullOr (jsonFormat.type);
default = null;
example = { direction = "up"; };
description = lib.mdDoc "Optional arguments for a command.";
description = "Optional arguments for a command.";
};
};
});
@ -165,7 +165,7 @@ in {
}
]
'';
description = lib.mdDoc ''
description = ''
Keybindings written to Visual Studio Code's
{file}`keybindings.json`.
'';
@ -175,7 +175,7 @@ in {
type = types.listOf types.package;
default = [ ];
example = literalExpression "[ pkgs.vscode-extensions.bbenoist.nix ]";
description = lib.mdDoc ''
description = ''
The extensions Visual Studio Code should be started with.
'';
};
@ -184,7 +184,7 @@ in {
type = types.bool;
default = true;
example = false;
description = lib.mdDoc ''
description = ''
Whether extensions can be installed or updated manually
or by Visual Studio Code.
'';
@ -202,8 +202,7 @@ in {
};
};
};
description =
lib.mdDoc "Defines user snippets for different languages.";
description = "Defines user snippets for different languages.";
};
globalSnippets = mkOption {
@ -216,7 +215,7 @@ in {
description = "Insert a FIXME remark";
};
};
description = lib.mdDoc "Defines global user snippets.";
description = "Defines global user snippets.";
};
};
};