treewide: remove now-redundant lib.mdDoc calls

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

View File

@@ -11,40 +11,39 @@ let
package = mkOption {
type = types.package;
example = literalExpression "pkgs.vanilla-dmz";
description = lib.mdDoc "Package providing the cursor theme.";
description = "Package providing the cursor theme.";
};
name = mkOption {
type = types.str;
example = "Vanilla-DMZ";
description = lib.mdDoc "The cursor name within the package.";
description = "The cursor name within the package.";
};
size = mkOption {
type = types.int;
default = 32;
example = 64;
description = lib.mdDoc "The cursor size.";
description = "The cursor size.";
};
x11 = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
x11 config generation for {option}`home.pointerCursor`
'');
'';
defaultCursor = mkOption {
type = types.str;
default = "left_ptr";
example = "X_cursor";
description =
lib.mdDoc "The default cursor file to use within the package.";
description = "The default cursor file to use within the package.";
};
};
gtk = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
gtk config generation for {option}`home.pointerCursor`
'');
'';
};
};
};
@@ -57,22 +56,22 @@ in {
meta.maintainers = [ maintainers.polykernel maintainers.league ];
imports = [
(mkAliasOptionModuleMD [ "xsession" "pointerCursor" "package" ] [
(mkAliasOptionModule [ "xsession" "pointerCursor" "package" ] [
"home"
"pointerCursor"
"package"
])
(mkAliasOptionModuleMD [ "xsession" "pointerCursor" "name" ] [
(mkAliasOptionModule [ "xsession" "pointerCursor" "name" ] [
"home"
"pointerCursor"
"name"
])
(mkAliasOptionModuleMD [ "xsession" "pointerCursor" "size" ] [
(mkAliasOptionModule [ "xsession" "pointerCursor" "size" ] [
"home"
"pointerCursor"
"size"
])
(mkAliasOptionModuleMD [ "xsession" "pointerCursor" "defaultCursor" ] [
(mkAliasOptionModule [ "xsession" "pointerCursor" "defaultCursor" ] [
"home"
"pointerCursor"
"x11"
@@ -95,7 +94,7 @@ in {
home.pointerCursor = mkOption {
type = types.nullOr pointerCursorModule;
default = null;
description = lib.mdDoc ''
description = ''
Cursor configuration. Set to `null` to disable.
Top-level options declared under this submodule are backend independent

View File

@@ -40,7 +40,7 @@ in {
options = {
i18n.glibcLocales = mkOption {
type = types.path;
description = lib.mdDoc ''
description = ''
Customized `glibcLocales` package providing
the `LOCALE_ARCHIVE_*` environment variable.