summary refs log tree commit diff
path: root/nixos/modules/services/editors/emacs.nix
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-28 21:18:44 +0200
committerpennae <github@quasiparticle.net>2022-08-31 16:32:53 +0200
commitef176dcf7e76c3639571d7c6051246c8fbadf12a (patch)
tree3bb88ef3515ace2ad477e245bf347213c6055464 /nixos/modules/services/editors/emacs.nix
parent5a643387ec1234c5f25357f2ff962a84895436f6 (diff)
downloadnixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.gz
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.bz2
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.lz
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.xz
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.tar.zst
nixpkgs-ef176dcf7e76c3639571d7c6051246c8fbadf12a.zip
nixos/*: automatically convert option descriptions
conversions were done using https://github.com/pennae/nix-doc-munge
using (probably) rev f34e145 running

    nix-doc-munge nixos/**/*.nix
    nix-doc-munge --import nixos/**/*.nix

the tool ensures that only changes that could affect the generated
manual *but don't* are committed, other changes require manual review
and are discarded.
Diffstat (limited to 'nixos/modules/services/editors/emacs.nix')
-rw-r--r--nixos/modules/services/editors/emacs.nix12
1 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix
index 0d9949d2ba5..5ae28cd9bbb 100644
--- a/nixos/modules/services/editors/emacs.nix
+++ b/nixos/modules/services/editors/emacs.nix
@@ -41,24 +41,24 @@ in
     enable = mkOption {
       type = types.bool;
       default = false;
-      description = ''
-        Whether to enable a user service for the Emacs daemon. Use <literal>emacsclient</literal> to connect to the
-        daemon. If <literal>true</literal>, <varname>services.emacs.install</varname> is
-        considered <literal>true</literal>, whatever its value.
+      description = lib.mdDoc ''
+        Whether to enable a user service for the Emacs daemon. Use `emacsclient` to connect to the
+        daemon. If `true`, {var}`services.emacs.install` is
+        considered `true`, whatever its value.
       '';
     };
 
     install = mkOption {
       type = types.bool;
       default = false;
-      description = ''
+      description = lib.mdDoc ''
         Whether to install a user service for the Emacs daemon. Once
         the service is started, use emacsclient to connect to the
         daemon.
 
         The service must be manually started for each user with
         "systemctl --user start emacs" or globally through
-        <varname>services.emacs.enable</varname>.
+        {var}`services.emacs.enable`.
       '';
     };