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

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

14
modules/programs/vim.nix
View file

@ -63,13 +63,13 @@ let
in {
options = {
programs.vim = {
enable = mkEnableOption (lib.mdDoc "Vim");
enable = mkEnableOption "Vim";
plugins = mkOption {
type = with types; listOf (either str package);
default = defaultPlugins;
example = literalExpression "[ pkgs.vimPlugins.YankRing ]";
description = lib.mdDoc ''
description = ''
List of vim plugins to install. To get a list of supported plugins run:
{command}`nix-env -f '<nixpkgs>' -qaP -A vimPlugins`.
@ -87,7 +87,7 @@ in {
background = "dark";
}
'';
description = lib.mdDoc ''
description = ''
At attribute set of Vim settings. The attribute names and
corresponding values must be among the following supported
options.
@ -110,18 +110,18 @@ in {
set nocompatible
set nobackup
'';
description = lib.mdDoc "Custom .vimrc lines";
description = "Custom .vimrc lines";
};
package = mkOption {
type = types.package;
description = lib.mdDoc "Resulting customized vim package";
description = "Resulting customized vim package";
readOnly = true;
};
packageConfigurable = mkOption {
type = types.package;
description = lib.mdDoc "Vim package to customize";
description = "Vim package to customize";
default = pkgs.vim-full or pkgs.vim_configurable;
defaultText = literalExpression "pkgs.vim-full";
example = literalExpression "pkgs.vim";
@ -130,7 +130,7 @@ in {
defaultEditor = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to configure {command}`vim` as the default
editor using the {env}`EDITOR` environment variable.
'';