foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-04-19 06:19:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modules: fix description

Browse Source 
Didn't notice it was `mkDocs` instead of `mdDocs`.
This commit is contained in:
Gabriel Arazas 2023-07-19 22:46:40 +08:00
parent 28faf41a1c
commit e8a05bef8b
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
modules/home-manager/files/mutable-files.nix
View File

@ -7,7 +7,7 @@ let
options = { options = {
url = lib.mkOption { url = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = lib.mkDoc '' description = lib.mdDoc ''
The URL of the file to be fetched. The URL of the file to be fetched.
''; '';
example = "https://github.com/foo-dogsquared/dotfiles.git"; example = "https://github.com/foo-dogsquared/dotfiles.git";
@ -15,7 +15,7 @@ let
path = lib.mkOption { path = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = lib.mkDoc '' description = lib.mdDoc ''
The path of the mutable file. By default, it will be relative to the The path of the mutable file. By default, it will be relative to the
home directory. home directory.
''; '';
@ -27,7 +27,7 @@ let
extractPath = lib.mkOption { extractPath = lib.mkOption {
type = with lib.types; nullOr str; 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 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 type is `archive`. If the value is `null` then it will extract the
whole archive into the directory. whole archive into the directory.
@ -38,7 +38,7 @@ let
type = lib.mkOption { type = lib.mkOption {
type = lib.types.enum [ "git" "fetch" "archive" "gopass" ]; type = lib.types.enum [ "git" "fetch" "archive" "gopass" ];
description = lib.mkDoc '' description = lib.mdDoc ''
Type that configures the behavior for fetching the URL. Type that configures the behavior for fetching the URL.
This accept only certain keywords. This accept only certain keywords.
@ -57,7 +57,7 @@ let
extraArgs = lib.mkOption { extraArgs = lib.mkOption {
type = with lib.types; listOf str; 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 A list of extra arguments to be included with the fetch command. Take
note of the commands used for each type as documented from note of the commands used for each type as documented from
`config.home.mutableFile.<name>.type`. `config.home.mutableFile.<name>.type`.
@ -71,7 +71,7 @@ in
{ {
options.home.mutableFile = lib.mkOption { options.home.mutableFile = lib.mkOption {
type = with lib.types; attrsOf (submodule (fileType config.home.homeDirectory)); 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 An attribute set of mutable files and directories to be declaratively put
into the home directory. Take note this is not exactly pure (or 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 idempotent) as it will only do its fetching when the designated file is

4
modules/home-manager/services/distant.nix
View File

@ -14,14 +14,14 @@ in
enable = lib.mkEnableOption "Distant-related services"; enable = lib.mkEnableOption "Distant-related services";
package = lib.mkOption { 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; type = lib.types.package;
default = pkgs.distant; default = pkgs.distant;
defaultText = "pkgs.distant"; defaultText = "pkgs.distant";
}; };
settings = lib.mkOption { settings = lib.mkOption {
description = lib.mkDoc '' description = lib.mdDoc ''
The configuration settings to be passed to the service. The configuration settings to be passed to the service.
''; '';
types = settingsFormat.type; types = settingsFormat.type;