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

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/beets.nix
View file

@ -20,7 +20,7 @@ in {
else
cfg.settings != { };
defaultText = "false";
description = lib.mdDoc ''
description = ''
Whether to enable the beets music library manager. This
defaults to `false` for state
version ≥ 19.03. For earlier versions beets is enabled if
@ -34,7 +34,7 @@ in {
defaultText = literalExpression "pkgs.beets";
example =
literalExpression "(pkgs.beets.override { enableCheck = true; })";
description = lib.mdDoc ''
description = ''
The `beets` package to use.
Can be used to specify extensions.
'';
@ -43,22 +43,22 @@ in {
settings = mkOption {
type = yamlFormat.type;
default = { };
description = lib.mdDoc ''
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/beets/config.yaml`
'';
};
mpdIntegration = {
enableStats = mkEnableOption (lib.mdDoc "mpdstats plugin and service");
enableStats = mkEnableOption "mpdstats plugin and service";
enableUpdate = mkEnableOption (lib.mdDoc "mpdupdate plugin");
enableUpdate = mkEnableOption "mpdupdate plugin";
host = mkOption {
type = types.str;
default = "localhost";
example = "10.0.0.42";
description = lib.mdDoc "The host that mpdstats will connect to.";
description = "The host that mpdstats will connect to.";
};
port = mkOption {
@ -66,7 +66,7 @@ in {
default = config.services.mpd.network.port;
defaultText = literalExpression "config.services.mpd.network.port";
example = 6601;
description = lib.mdDoc "The port that mpdstats will connect to.";
description = "The port that mpdstats will connect to.";
};
};
};