From e8a05bef8be750b1d3add61e7a25e345b8797a91 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Wed, 19 Jul 2023 22:46:40 +0800 Subject: [PATCH] modules: fix description Didn't notice it was `mkDocs` instead of `mdDocs`. --- modules/home-manager/files/mutable-files.nix | 12 ++++++------ modules/home-manager/services/distant.nix | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/home-manager/files/mutable-files.nix b/modules/home-manager/files/mutable-files.nix index f77e6e88..816ccc6f 100644 --- a/modules/home-manager/files/mutable-files.nix +++ b/modules/home-manager/files/mutable-files.nix @@ -7,7 +7,7 @@ let options = { url = lib.mkOption { type = lib.types.str; - description = lib.mkDoc '' + description = lib.mdDoc '' The URL of the file to be fetched. ''; example = "https://github.com/foo-dogsquared/dotfiles.git"; @@ -15,7 +15,7 @@ let path = lib.mkOption { type = lib.types.str; - description = lib.mkDoc '' + description = lib.mdDoc '' The path of the mutable file. By default, it will be relative to the home directory. ''; @@ -27,7 +27,7 @@ let extractPath = lib.mkOption { type = with lib.types; nullOr str; - description = lib.mkDoc '' + description = lib.mdDoc '' The path within the archive to be extracted. This is only used if the type is `archive`. If the value is `null` then it will extract the whole archive into the directory. @@ -38,7 +38,7 @@ let type = lib.mkOption { type = lib.types.enum [ "git" "fetch" "archive" "gopass" ]; - description = lib.mkDoc '' + description = lib.mdDoc '' Type that configures the behavior for fetching the URL. This accept only certain keywords. @@ -57,7 +57,7 @@ let extraArgs = lib.mkOption { type = with lib.types; listOf str; - description = lib.mkDoc '' + description = lib.mdDoc '' A list of extra arguments to be included with the fetch command. Take note of the commands used for each type as documented from `config.home.mutableFile..type`. @@ -71,7 +71,7 @@ in { options.home.mutableFile = lib.mkOption { type = with lib.types; attrsOf (submodule (fileType config.home.homeDirectory)); - description = lib.mkDoc '' + description = lib.mdDoc '' An attribute set of mutable files and directories to be declaratively put into the home directory. Take note this is not exactly pure (or idempotent) as it will only do its fetching when the designated file is diff --git a/modules/home-manager/services/distant.nix b/modules/home-manager/services/distant.nix index 138c2926..e2a7ec94 100644 --- a/modules/home-manager/services/distant.nix +++ b/modules/home-manager/services/distant.nix @@ -14,14 +14,14 @@ in enable = lib.mkEnableOption "Distant-related services"; package = lib.mkOption { - description = lib.mkDoc "The package containing the `distant` executable."; + description = lib.mdDoc "The package containing the `distant` executable."; type = lib.types.package; default = pkgs.distant; defaultText = "pkgs.distant"; }; settings = lib.mkOption { - description = lib.mkDoc '' + description = lib.mdDoc '' The configuration settings to be passed to the service. ''; types = settingsFormat.type;