chn/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-01-12 01:59:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

35
modules/programs/thunderbird.nix
View File

@@ -124,14 +124,14 @@ in {
options = {
programs.thunderbird = {
enable = mkEnableOption (lib.mdDoc "Thunderbird");
enable = mkEnableOption "Thunderbird";
package = mkOption {
type = types.package;
default = pkgs.thunderbird;
defaultText = literalExpression "pkgs.thunderbird";
example = literalExpression "pkgs.thunderbird-91";
description = lib.mdDoc "The Thunderbird package to use.";
description = "The Thunderbird package to use.";
};
profiles = mkOption {
@@ -142,14 +142,14 @@ in {
type = types.str;
default = name;
readOnly = true;
description = lib.mdDoc "This profile's name.";
description = "This profile's name.";
};
isDefault = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc ''
description = ''
Whether this is a default profile. There must be exactly one
default profile.
'';
@@ -163,7 +163,7 @@ in {
"mail.spellcheck.inline" = false;
}
'';
description = lib.mdDoc ''
description = ''
Preferences to add to this profile's
{file}`user.js`.
'';
@@ -173,14 +173,13 @@ in {
type = types.bool;
default = false;
example = true;
description =
lib.mdDoc "Allow using external GPG keys with GPGME.";
description = "Allow using external GPG keys with GPGME.";
};
userChrome = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Custom Thunderbird user chrome CSS.";
description = "Custom Thunderbird user chrome CSS.";
example = ''
/* Hide tab bar in Thunderbird */
#tabs-toolbar {
@@ -192,7 +191,7 @@ in {
userContent = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Custom Thunderbird user content CSS.";
description = "Custom Thunderbird user content CSS.";
example = ''
/* Hide scrollbar on Thunderbird pages */
*{scrollbar-width:none !important}
@@ -202,13 +201,13 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Extra preferences to add to {file}`user.js`.
'';
};
};
}));
description = lib.mdDoc "Attribute set of Thunderbird profiles.";
description = "Attribute set of Thunderbird profiles.";
};
settings = mkOption {
@@ -220,7 +219,7 @@ in {
"privacy.donottrackheader.enabled" = true;
}
'';
description = lib.mdDoc ''
description = ''
Attribute set of Thunderbird preferences to be added to
all profiles.
'';
@@ -232,7 +231,7 @@ in {
example = false;
visible = isDarwin;
readOnly = !isDarwin;
description = lib.mdDoc ''
description = ''
Warn to set environment variables before using this module. Only
relevant on Darwin.
'';
@@ -243,8 +242,8 @@ in {
type = with types;
attrsOf (submodule {
options.thunderbird = {
enable = mkEnableOption
(lib.mdDoc "the Thunderbird mail client for this account");
enable =
mkEnableOption "the Thunderbird mail client for this account";
profiles = mkOption {
type = with types; listOf str;
@@ -252,7 +251,7 @@ in {
example = literalExpression ''
[ "profile1" "profile2" ]
'';
description = lib.mdDoc ''
description = ''
List of Thunderbird profiles for which this account should be
enabled. If this list is empty (the default), this account will
be enabled for all declared profiles.
@@ -268,7 +267,7 @@ in {
"mail.server.server_''${id}.check_new_mail" = false;
};
'';
description = lib.mdDoc ''
description = ''
Extra settings to add to this Thunderbird account configuration.
The {var}`id` given as argument is an automatically
generated account identifier.
@@ -285,7 +284,7 @@ in {
"mail.identity.id_''${id}.autoEncryptDrafts" = false;
};
'';
description = lib.mdDoc ''
description = ''
Extra settings to add to each identity of this Thunderbird
account configuration. The {var}`id` given as
argument is an automatically generated identifier.